From 40151eab036aecdec99c661fcf5ada80ab8b0082 Mon Sep 17 00:00:00 2001 From: Gordon Brown Date: Tue, 19 May 2020 13:33:36 -0600 Subject: [PATCH] Add expand_wildcards to _cat/indices and _cat/aliases docs 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. --- docs/reference/cat/alias.asciidoc | 2 ++ docs/reference/cat/indices.asciidoc | 2 ++ docs/reference/rest-api/common-parms.asciidoc | 10 ++++++---- 3 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/reference/cat/alias.asciidoc b/docs/reference/cat/alias.asciidoc index 4191b94c2d47c..29008a9bb6f1a 100644 --- a/docs/reference/cat/alias.asciidoc +++ b/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} diff --git a/docs/reference/cat/indices.asciidoc b/docs/reference/cat/indices.asciidoc index b88dfb45fb2a9..3a8b773e37a34 100644 --- a/docs/reference/cat/indices.asciidoc +++ b/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} diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index 8d25d601ae2a1..804f3b77710ee 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/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 <>. `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 <>. +Must be combined with `open`, `closed`, or both. `none`:: Wildcard expressions are not accepted.