[DOCS] Document _cat/tasks API
#47321
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jrodewig
added
>docs
|
Pinging @elastic/es-distributed |
|
Pinging @elastic/es-core-features |
|
Pinging @elastic/es-docs |
imotov
approved these changes
Oct 1, 2019
| <titleabbrev>cat task management</titleabbrev> | ||
| ++++ | ||
|
|
||
| beta::[The cat task management API is new and should still be considered a beta feature. The API may change in ways that are not backwards compatible.] |
There was a problem hiding this comment.
I am not totally sure why task management is still beta. Perhaps, it is time to start a discussion about removal of this label. But since the non-cat API is marked beta, it is appropriate to use this label here as well.
There was a problem hiding this comment.
I've opened #47378 to discuss this more.
| [[cat-tasks-api-path-params]] | ||
| ==== {api-path-parms-title} | ||
|
|
||
| include::{docdir}/rest-api/common-parms.asciidoc[tag=task-id] |
There was a problem hiding this comment.
Looking at the code, it should also support detailed, wait_for_completion and timeout flags. They are not as useful in the cat context but we can add them for completeness.
There was a problem hiding this comment.
Thanks! These are included under the query parameters section.
This was referenced Oct 1, 2019
jrodewig
added a commit
that referenced
this pull request
Oct 1, 2019
jrodewig
added a commit
that referenced
this pull request
Oct 1, 2019
jrodewig
added a commit
that referenced
this pull request
Oct 1, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
_cat/tasksAPI, similar to other cat APIsCloses #19756