From f7531c701cca199cd76434d92bb88d90e1417874 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Mon, 8 Feb 2021 12:50:52 -0500 Subject: [PATCH] [DOCS] Format the multi search api doc (#68621) (#68692) Co-authored-by: bellengao --- docs/reference/search/multi-search.asciidoc | 27 ++++++++++++++++++++- 1 file changed, 26 insertions(+), 1 deletion(-) diff --git a/docs/reference/search/multi-search.asciidoc b/docs/reference/search/multi-search.asciidoc index c46a19fc14742..3cab051628b4e 100644 --- a/docs/reference/search/multi-search.asciidoc +++ b/docs/reference/search/multi-search.asciidoc @@ -185,7 +185,32 @@ If `true`, the request does *not* return an error if a wildcard expression or This parameter also applies to <> 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 <> 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`.