From 4007e13ebc9301be6ddd908219dcc2943c7ad01c Mon Sep 17 00:00:00 2001
From: olcbean <olcbean@yahoo.com>
Date: Wed, 14 Feb 2018 15:31:22 +0100
Subject: [PATCH] Add a note to the docs that _cat api `help` option cannot be
 used if an optional url param is used

---
 docs/reference/cat.asciidoc | 7 ++++++-
 1 file changed, 6 insertions(+), 1 deletion(-)

diff --git a/docs/reference/cat.asciidoc b/docs/reference/cat.asciidoc
index 31e0bf61707e3..3dff5abc52d9a 100644
--- 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