Browse Source

Add expand_wildcards to _cat/indices and _cat/aliases docs (#56964)

This commit adds the `expand_wildcards` parameter documentation to the
`_cat/indices` and `_cat/aliases` docs, as those APIs now support
`expand_wildcards`. Additionally, clarifies the `expand_wildcards` docs with
respect to hidden indices.
Gordon Brown 5 years ago
parent
commit
741b64695f

+ 2 - 0
docs/reference/cat/alias.asciidoc

@@ -38,6 +38,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s]
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]
 
+include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
+
 
 [[cat-alias-api-example]]
 ==== {api-examples-title}

+ 2 - 0
docs/reference/cat/indices.asciidoc

@@ -83,6 +83,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=time]
 
 include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]
 
+include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
+
 
 [[cat-indices-api-example]]
 ==== {api-examples-title}

+ 6 - 4
docs/reference/rest-api/common-parms.asciidoc

@@ -206,11 +206,12 @@ tag::expand-wildcards[]
 `expand_wildcards`::
 +
 --
-(Optional, string) Controls what kind of indices that wildcard
-expressions can expand to. Valid values are:
+(Optional, string) Controls what kind of indices that wildcard expressions can
+expand to. Multiple values are accepted when separated by a comma, as in
+`open,hidden`. Valid values are:
 
 `all`::
-Expand to open and closed indices.
+Expand to open and closed indices, including <<index-hidden,hidden indices>>.
 
 `open`::
 Expand only to open indices.
@@ -219,7 +220,8 @@ Expand only to open indices.
 Expand only to closed indices.
 
 `hidden`::
-Expansion of wildcards will include hidden indices.
+Expansion of wildcards will include <<index-hidden,hidden indices>>.
+Must be combined with `open`, `closed`, or both.
 
 `none`::
 Wildcard expressions are not accepted.