Skip to content

Commit b806e6e

Browse files
committed
[DOCS] Reformats cat pending tasks API (#45287)
1 parent 276e9c6 commit b806e6e

File tree

1 file changed

+29
-4
lines changed

1 file changed

+29
-4
lines changed

docs/reference/cat/pending_tasks.asciidoc

Lines changed: 29 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,42 @@
11
[[cat-pending-tasks]]
22
=== cat pending tasks
33

4-
`pending_tasks` provides the same information as the
5-
<<cluster-pending,`/_cluster/pending_tasks`>> API in a
6-
convenient tabular format. For example:
4+
Returns cluster-level changes that have not yet been executed, similar to the
5+
<<cluster-pending, pending cluster tasks>> API.
6+
7+
[[cat-pending-tasks-api-request]]
8+
==== {api-request-title}
9+
10+
`GET /_cat/pending_tasks`
11+
12+
[[cat-pending-tasks-api-query-params]]
13+
==== {api-query-parms-title}
14+
15+
include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]
16+
17+
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]
18+
19+
include::{docdir}/rest-api/common-parms.asciidoc[tag=help]
20+
21+
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
22+
23+
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
24+
25+
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s]
26+
27+
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]
28+
29+
30+
[[cat-pending-tasks-api-example]]
31+
==== {api-examples-title}
732

833
[source,js]
934
--------------------------------------------------
1035
GET /_cat/pending_tasks?v
1136
--------------------------------------------------
1237
// CONSOLE
1338

14-
Might look like:
39+
The API returns the following response:
1540

1641
[source,txt]
1742
--------------------------------------------------

0 commit comments

Comments
 (0)