Skip to content

Commit f50aaa3

Browse files
authored
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.
1 parent 9d26347 commit f50aaa3

File tree

3 files changed

+10
-4
lines changed

3 files changed

+10
-4
lines changed

docs/reference/cat/alias.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s]
3838

3939
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]
4040

41+
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
42+
4143

4244
[[cat-alias-api-example]]
4345
==== {api-examples-title}

docs/reference/cat/indices.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=time]
8383

8484
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]
8585

86+
include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
87+
8688

8789
[[cat-indices-api-example]]
8890
==== {api-examples-title}

docs/reference/rest-api/common-parms.asciidoc

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -211,11 +211,12 @@ tag::expand-wildcards[]
211211
`expand_wildcards`::
212212
+
213213
--
214-
(Optional, string) Controls what kind of indices that wildcard
215-
expressions can expand to. Valid values are:
214+
(Optional, string) Controls what kind of indices that wildcard expressions can
215+
expand to. Multiple values are accepted when separated by a comma, as in
216+
`open,hidden`. Valid values are:
216217

217218
`all`::
218-
Expand to open and closed indices.
219+
Expand to open and closed indices, including <<index-hidden,hidden indices>>.
219220

220221
`open`::
221222
Expand only to open indices.
@@ -224,7 +225,8 @@ Expand only to open indices.
224225
Expand only to closed indices.
225226

226227
`hidden`::
227-
Expansion of wildcards will include hidden indices.
228+
Expansion of wildcards will include <<index-hidden,hidden indices>>.
229+
Must be combined with `open`, `closed`, or both.
228230

229231
`none`::
230232
Wildcard expressions are not accepted.

0 commit comments

Comments
 (0)