Skip to content

Commit 2f72e99

Browse files
authored
Revert "Improve description for task api detailed param (#88493)"
This reverts commit 1147396.
1 parent 1147396 commit 2f72e99

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/reference/cluster/tasks.asciidoc

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,13 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
5353
`wait_for_completion`::
5454
(Optional, Boolean) If `true`, the request blocks until the operation is complete.
5555
Defaults to `false`.
56-
56+
5757
[[tasks-api-response-codes]]
5858
==== {api-response-codes-title}
5959

6060
// tag::tasks-api-404[]
6161
`404` (Missing resources)::
62-
If `<task_id>` is specified but not found, this code indicates that there
62+
If `<task_id>` is specified but not found, this code indicates that there
6363
are no resources that match the request.
6464
// end::tasks-api-404[]
6565

@@ -117,7 +117,7 @@ The API returns the following result:
117117

118118
===== Retrieve information from a particular task
119119

120-
It is also possible to retrieve information for a particular task. The following
120+
It is also possible to retrieve information for a particular task. The following
121121
example retrieves information about task `oTUltX4IQMOUUVeiohTt8A:124`:
122122

123123
[source,console]
@@ -141,8 +141,8 @@ If the parent isn't found, the API does not return a 404.
141141
===== Get more information about tasks
142142

143143
You can also use the `detailed` request parameter to get more information about
144-
the running tasks. This is useful to distinguish tasks from each other but
145-
is more costly to execute. For example, fetching all searches using the `detailed`
144+
the running tasks. This is useful for telling one task from another but is more
145+
costly to execute. For example, fetching all searches using the `detailed`
146146
request parameter:
147147

148148
[source,console]
@@ -215,7 +215,7 @@ GET _tasks/oTUltX4IQMOUUVeiohTt8A:12345?wait_for_completion=true&timeout=10s
215215
--------------------------------------------------
216216
// TEST[catch:missing]
217217

218-
You can also wait for all tasks for certain action types to finish. This command
218+
You can also wait for all tasks for certain action types to finish. This command
219219
will wait for all `reindex` tasks to finish:
220220

221221
[source,console]
@@ -226,17 +226,17 @@ GET _tasks?actions=*reindex&wait_for_completion=true&timeout=10s
226226
[[task-cancellation]]
227227
===== Task Cancellation
228228

229-
If a long-running task supports cancellation, it can be cancelled with the cancel
229+
If a long-running task supports cancellation, it can be cancelled with the cancel
230230
tasks API. The following example cancels task `oTUltX4IQMOUUVeiohTt8A:12345`:
231231

232232
[source,console]
233233
--------------------------------------------------
234234
POST _tasks/oTUltX4IQMOUUVeiohTt8A:12345/_cancel
235235
--------------------------------------------------
236236

237-
The task cancellation command supports the same task selection parameters as the
238-
list tasks command, so multiple tasks can be cancelled at the same time. For
239-
example, the following command will cancel all reindex tasks running on the
237+
The task cancellation command supports the same task selection parameters as the
238+
list tasks command, so multiple tasks can be cancelled at the same time. For
239+
example, the following command will cancel all reindex tasks running on the
240240
nodes `nodeId1` and `nodeId2`.
241241

242242
[source,console]
@@ -253,8 +253,8 @@ possible.
253253

254254
===== Task Grouping
255255

256-
The task lists returned by task API commands can be grouped either by nodes
257-
(default) or by parent tasks using the `group_by` parameter. The following
256+
The task lists returned by task API commands can be grouped either by nodes
257+
(default) or by parent tasks using the `group_by` parameter. The following
258258
command will change the grouping to parent tasks:
259259

260260
[source,console]
@@ -272,9 +272,9 @@ GET _tasks?group_by=none
272272

273273
===== Identifying running tasks
274274

275-
The `X-Opaque-Id` header, when provided on the HTTP request header, is going to
276-
be returned as a header in the response as well as in the `headers` field for in
277-
the task information. This allows to track certain calls, or associate certain
275+
The `X-Opaque-Id` header, when provided on the HTTP request header, is going to
276+
be returned as a header in the response as well as in the `headers` field for in
277+
the task information. This allows to track certain calls, or associate certain
278278
tasks with the client that started them:
279279

280280
[source,sh]

0 commit comments

Comments
 (0)