honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-17 10:25:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add a note to the docs that _cat api help option cannot be used if an optional url param is used (#28686)

Browse Source
This commit is contained in:
olcbean 2018-02-15 15:56:01 +01:00 committed by Boaz Leskes
parent 671e7e2f00
commit 658ca5e10b
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reference/cat.asciidoc
View File

@ -55,7 +55,7 @@ GET /_cat/master?help
--------------------------------------------------
// CONSOLE
Might respond respond with:
Might respond with:
[source,txt]
--------------------------------------------------
@ -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