@@ -161,86 +161,62 @@ shards. This is usually slower but more accurate.
161161Specifies whether aggregation and suggester names should be prefixed by their
162162respective types in the response.
163163
164+ [role="child_attributes"]
164165[[search-multi-search-api-request-body]]
165166==== {api-request-body-title}
166167
167168The request body contains a newline-delimited list of search `<header>` and
168169search `<body>` objects.
169170
170171`<header>`::
171- +
172- --
173172(Required, object)
174173Contains parameters used to limit or change the subsequent search body request.
175-
174+ +
176175This object is required for each search body but can be empty (`{}`) or a blank
177176line.
178- --
179-
180- `allow_no_indices`:::
177+ +
178+ .Properties of `<header>` objects
179+ [%collapsible%open]
180+ ====
181+ `allow_no_indices`::
181182(Optional, Boolean)
182183If `true`, the request does *not* return an error if a wildcard expression or
183184`_all` value retrieves only missing or closed indices.
184185+
185186This parameter also applies to <<indices-aliases,index aliases>> that point to a
186187missing or closed index.
187188
188- `expand_wildcards`:::
189- +
190- --
191- (Optional, string)
192- Type of index that wildcard expressions can match. If the request can target
193- data streams, this argument determines whether wildcard expressions match
194- hidden data streams. Supports comma-separated values, such as `open,hidden`.
195- Valid values are:
196-
197- `all`::
198- Match any data stream or index, including <<hidden-indices,hidden>> ones.
199-
200- `open`::
201- Match open, non-hidden indices. Also matches any non-hidden data stream.
202-
203- `closed`::
204- Match closed, non-hidden indices. Also matches any non-hidden data stream. Data
205- streams cannot be closed.
206-
207- `hidden`::
208- Match hidden data streams and hidden indices. Must be combined with `open`,
209- `closed`, or both.
210-
211- `none`::
212- Wildcard expressions are not accepted.
213- --
189+ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
214190+
215191Defaults to `open`.
216192
217- `ignore_unavailable`:::
193+ `ignore_unavailable`::
218194(Optional, Boolean) If `true`, documents from missing or closed indices are not
219195included in the response. Defaults to `false`.
220196
221- `index`:::
197+ `index`::
222198(Optional, string or array of strings)
223199Data streams, indices, and index aliases to search. Wildcard (`*`) expressions
224200are supported. You can specify multiple targets as an array.
225201+
226202If this parameter is not specified, the `<target>` request path parameter
227203is used as a fallback.
228204
229- `preference`:::
205+ `preference`::
230206(Optional, string)
231207Node or shard used to perform the search. Random by default.
232208
233- `request_cache`:::
209+ `request_cache`::
234210(Optional, Boolean)
235211If `true`, the request cache can be used for this search. Defaults to
236212index-level settings. See <<shard-request-cache>>.
237213
238- `routing`:::
214+ `routing`::
239215(Optional, string)
240216Custom <<mapping-routing-field,routing value>> used to route search operations
241217to a specific shard.
242218
243- `search_type`:::
219+ `search_type`::
244220+
245221--
246222(Optional, string)
@@ -249,35 +225,40 @@ scoring returned documents.
249225
250226Options are:
251227
252- `query_then_fetch`::
228+ `query_then_fetch`:::
253229(default)
254230Documents are scored using local term and document frequencies for the shard.
255231This is usually faster but less accurate.
256232
257- `dfs_query_then_fetch`::
233+ `dfs_query_then_fetch`:::
258234Documents are scored using global term and document frequencies across all
259235shards. This is usually slower but more accurate.
260236--
237+ ====
261238
262239`<body>`::
263240(Optional, object)
264241Contains parameters for a search request:
265-
266- `aggregations`:::
242+ +
243+ .Properties of `<body>` objects
244+ [%collapsible%open]
245+ ====
246+ `aggregations`::
267247(Optional, <<search-aggregations,aggregation object>>)
268248Aggregations you wish to run during the search. See <<search-aggregations>>.
269249
270- `query`:::
250+ `query`::
271251(Optional, <<query-dsl,query DSL object>>) Query you wish to run during the
272252search. Hits matching this query are returned in the response.
273253
274- `from`:::
254+ `from`::
275255(Optional, integer)
276256Starting offset for returned hits. Defaults to `0`.
277257
278- `size`:::
258+ `size`::
279259(Optional, integer)
280260Number of hits to return. Defaults to `10`.
261+ ====
281262
282263[[search-multi-search-api-response-body]]
283264==== {api-response-body-title}
0 commit comments