Browse Source

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

olcbean 7 years ago
parent
commit
658ca5e10b
1 changed files with 6 additions and 1 deletions
  1. 6 1
      docs/reference/cat.asciidoc

+ 6 - 1
docs/reference/cat.asciidoc

@@ -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