Skip to content

Commit

Permalink
Add expand_wildcards to _cat/indices and _cat/aliases docs (#56964)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
gwbrown authored May 21, 2020
1 parent 7abd940 commit 741b646
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 4 deletions.
2 changes: 2 additions & 0 deletions docs/reference/cat/alias.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/cat/indices.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down
10 changes: 6 additions & 4 deletions docs/reference/rest-api/common-parms.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down

0 comments on commit 741b646

Please sign in to comment.