Skip to content

[docs] Add a note to the cat API for the help option #28686

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

Merged
merged 1 commit into from
Feb 15, 2018
Merged

[docs] Add a note to the cat API for the help option #28686

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 6 additions & 1 deletion docs/reference/cat.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ GET /_cat/master?help
--------------------------------------------------
// CONSOLE

Might respond respond with:
Might respond with:

[source,txt]
--------------------------------------------------
Expand All @@ -66,6 +66,11 @@ node | n | node name
--------------------------------------------------
// TESTRESPONSE[s/[|]/[|]/ _cat]

NOTE: `help` is not supported if any optional url parameter is used.
For example `GET _cat/shards/twitter?help` or `GET _cat/indices/twi*?help`
results in an error. Use `GET _cat/shards?help` or `GET _cat/indices?help`
instead.

[float]
[[headers]]
=== Headers
Expand Down