Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Remove individual task retrieval from cat/tasks API #49550

Merged
merged 3 commits into from
Nov 25, 2019
Merged

[DOCS] Remove individual task retrieval from cat/tasks API #49550

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c39c0cc
[DOCS] Remove individual task retrieval from cat/tasks API
jrodewig Nov 25, 2019
2bad502
fix merge conflict
jrodewig Nov 25, 2019
73ecbcf
remove header
jrodewig Nov 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 0 additions & 32 deletions docs/reference/cat/tasks.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,6 @@ similar to the <<tasks,task management>> API.
[[cat-tasks-api-request]]
==== {api-request-title}

`GET /_cat/tasks/<task_id>`

`GET /_cat/tasks`


Expand All @@ -28,12 +26,6 @@ It is a more compact view
of the JSON <<tasks,task management>> API.


[[cat-tasks-api-path-params]]
==== {api-path-parms-title}

include::{docdir}/rest-api/common-parms.asciidoc[tag=task-id]


[[cat-tasks-api-query-params]]
==== {api-query-parms-title}

Expand Down Expand Up @@ -71,30 +63,6 @@ include::{docdir}/cluster/tasks.asciidoc[tag=tasks-api-404]
[[cat-tasks-api-examples]]
==== {api-examples-title}


[[cat-tasks-api-specific-ex]]
===== Get information for a specific task

[source,console]
----
GET _cat/tasks/oTUltX4IQMOUUVeiohTt8A:124?v
----
// TEST[skip:No tasks to retrieve]

The API returns the following response:

[source,txt]
----
action task_id parent_task_id type start_time timestamp running_time ip node
cluster:monitor/tasks/lists[n] oTUltX4IQMOUUVeiohTt8A:124 oTUltX4IQMOUUVeiohTt8A:123 direct 1458585884904 01:48:24 44.1micros 127.0.0.1:9300 oTUltX4IQMOUUVeiohTt8A
----
// TESTRESPONSE[skip:No tasks to retrieve]
// TESTRESPONSE[non_json]


[[cat-tasks-api-all-ex]]
===== Get information for all tasks in a cluster

[source,console]
----
GET _cat/tasks?v
Expand Down