Skip to content

Commit

Permalink
[DOCS] Format the multi search api doc (#68621) (#68692)
Browse files Browse the repository at this point in the history
Co-authored-by: bellengao <gbl_long@163.com>
  • Loading branch information
jrodewig and gaobinlong committed Feb 8, 2021
1 parent acb2f0e commit f7531c7
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion docs/reference/search/multi-search.asciidoc
Expand Up @@ -185,7 +185,32 @@ If `true`, the request does *not* return an error if a wildcard expression or
This parameter also applies to <<indices-aliases,index aliases>> that point to a
missing or closed index.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
`expand_wildcards`:::
+
--
(Optional, string)
Type of index that wildcard expressions can match. If the request can target
data streams, this argument determines whether wildcard expressions match
hidden data streams. Supports comma-separated values, such as `open,hidden`.
Valid values are:

`all`::
Match any data stream or index, including <<hidden-indices,hidden>> ones.

`open`::
Match open, non-hidden indices. Also matches any non-hidden data stream.

`closed`::
Match closed, non-hidden indices. Also matches any non-hidden data stream. Data
streams cannot be closed.

`hidden`::
Match hidden data streams and hidden indices. Must be combined with `open`,
`closed`, or both.

`none`::
Wildcard expressions are not accepted.
--
+
Defaults to `open`.

Expand Down

0 comments on commit f7531c7

Please sign in to comment.