honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-22 21:05:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source 
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.
This commit is contained in:
Gordon Brown 2020-05-29 11:01:53 -06:00 committed by GitHub
parent 15aba60c02
commit 1d5e476256
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/reference/cat/alias.asciidoc
View File

@ -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
docs/reference/cat/indices.asciidoc
View File

@ -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}

10
docs/reference/rest-api/common-parms.asciidoc
View File

@ -216,11 +216,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.
@ -229,7 +230,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.