Add a note to the docs that _cat api help option cannot be used if …

…an optional url param is used (#28686)
elastic · Feb 15, 2018 · 658ca5e · 658ca5e
1 parent 671e7e2
commit 658ca5e
Showing 1 changed file with 6 additions and 1 deletion.
diff --git a/docs/reference/cat.asciidoc b/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