Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 21, 2020
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
40151ea
Add expand_wildcards to _cat/indices and _cat/aliases docs
gwbrown May 19, 2020
089e1a9
Merge branch 'master' into improve-hidden-docs
elasticmachine May 21, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/reference/cat/alias.asciidoc
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
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