diff --git a/docs/reference/cluster/state.asciidoc b/docs/reference/cluster/state.asciidoc index 567635c4d4bf5..3fbd0143f4a32 100644 --- a/docs/reference/cluster/state.asciidoc +++ b/docs/reference/cluster/state.asciidoc @@ -96,6 +96,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index] (Optional, boolean) If `true`, the wildcard indices expression that resolves into no concrete indices will be ignored. (This includes `_all` string or when no indices have been specified). ++ +Defaults to `true`. `expand_wildcards`:: (Optional, string) Whether to expand wildcard expression to concrete indices diff --git a/docs/reference/docs/delete-by-query.asciidoc b/docs/reference/docs/delete-by-query.asciidoc index 0646320320605..b064e6b9784bc 100644 --- a/docs/reference/docs/delete-by-query.asciidoc +++ b/docs/reference/docs/delete-by-query.asciidoc @@ -162,6 +162,8 @@ or omit to search all indices. ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer] diff --git a/docs/reference/indices/alias-exists.asciidoc b/docs/reference/indices/alias-exists.asciidoc index ed38e44edc251..de2a6baa44083 100644 --- a/docs/reference/indices/alias-exists.asciidoc +++ b/docs/reference/indices/alias-exists.asciidoc @@ -36,8 +36,6 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index] [[alias-exists-api-query-params]] ==== {api-query-parms-title} -include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] - include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + Defaults to `all`. diff --git a/docs/reference/indices/apis/reload-analyzers.asciidoc b/docs/reference/indices/apis/reload-analyzers.asciidoc index 9aae5cb99e4e3..b5df64c53aee6 100644 --- a/docs/reference/indices/apis/reload-analyzers.asciidoc +++ b/docs/reference/indices/apis/reload-analyzers.asciidoc @@ -74,6 +74,8 @@ used to limit the request. === {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/indices/clearcache.asciidoc b/docs/reference/indices/clearcache.asciidoc index 732f2928918d6..8caf99f6d3ff7 100644 --- a/docs/reference/indices/clearcache.asciidoc +++ b/docs/reference/indices/clearcache.asciidoc @@ -31,6 +31,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index] ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/indices/close.asciidoc b/docs/reference/indices/close.asciidoc index b44d38d79326d..f44a89de639e5 100644 --- a/docs/reference/indices/close.asciidoc +++ b/docs/reference/indices/close.asciidoc @@ -43,6 +43,8 @@ or using the <> API. ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/indices/delete-index.asciidoc b/docs/reference/indices/delete-index.asciidoc index 8f0ad0868814c..d3d6c243f07bc 100644 --- a/docs/reference/indices/delete-index.asciidoc +++ b/docs/reference/indices/delete-index.asciidoc @@ -43,6 +43,8 @@ this setting in the `elasticsearch.yml` file or using the ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + @@ -50,4 +52,4 @@ Defaults to `open`. include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] -include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] \ No newline at end of file +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] diff --git a/docs/reference/indices/flush.asciidoc b/docs/reference/indices/flush.asciidoc index 5729909e94f71..066d3256e81f8 100644 --- a/docs/reference/indices/flush.asciidoc +++ b/docs/reference/indices/flush.asciidoc @@ -64,6 +64,8 @@ or use a value of `_all` or `*`. ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/indices/forcemerge.asciidoc b/docs/reference/indices/forcemerge.asciidoc index 520f29732a7dc..f131daa087fe5 100644 --- a/docs/reference/indices/forcemerge.asciidoc +++ b/docs/reference/indices/forcemerge.asciidoc @@ -72,6 +72,8 @@ or use a value of `_all` or `*`. ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/indices/get-alias.asciidoc b/docs/reference/indices/get-alias.asciidoc index 0f2c4e88e5686..a57f34d7c7336 100644 --- a/docs/reference/indices/get-alias.asciidoc +++ b/docs/reference/indices/get-alias.asciidoc @@ -43,6 +43,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index] ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/indices/get-field-mapping.asciidoc b/docs/reference/indices/get-field-mapping.asciidoc index c0e5e6d46a5c5..17656bd58518c 100644 --- a/docs/reference/indices/get-field-mapping.asciidoc +++ b/docs/reference/indices/get-field-mapping.asciidoc @@ -37,6 +37,8 @@ limit returned information. ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] diff --git a/docs/reference/indices/get-index.asciidoc b/docs/reference/indices/get-index.asciidoc index 7d5a1c3561933..f8e8859274ce6 100644 --- a/docs/reference/indices/get-index.asciidoc +++ b/docs/reference/indices/get-index.asciidoc @@ -40,6 +40,8 @@ Use a value of `_all` to retrieve information for all indices in the cluster. ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + @@ -55,4 +57,4 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] include::{docdir}/rest-api/common-parms.asciidoc[tag=local] -include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] \ No newline at end of file +include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] diff --git a/docs/reference/indices/get-mapping.asciidoc b/docs/reference/indices/get-mapping.asciidoc index 81b2cd826d900..1d8036dd55ac9 100644 --- a/docs/reference/indices/get-mapping.asciidoc +++ b/docs/reference/indices/get-mapping.asciidoc @@ -35,6 +35,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index] ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/indices/get-settings.asciidoc b/docs/reference/indices/get-settings.asciidoc index e0a3df14992bc..cb4c0b847ce29 100644 --- a/docs/reference/indices/get-settings.asciidoc +++ b/docs/reference/indices/get-settings.asciidoc @@ -37,6 +37,8 @@ used to limit the request. ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + @@ -82,4 +84,4 @@ as follows: -------------------------------------------------- GET /log_2013_-*/_settings/index.number_* -------------------------------------------------- -// TEST[continued] \ No newline at end of file +// TEST[continued] diff --git a/docs/reference/indices/indices-exists.asciidoc b/docs/reference/indices/indices-exists.asciidoc index eb7936a7583a0..113724cc4ce95 100644 --- a/docs/reference/indices/indices-exists.asciidoc +++ b/docs/reference/indices/indices-exists.asciidoc @@ -32,6 +32,8 @@ i.e. status code `200` is also returned if an alias exists with that name. ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/indices/open-close.asciidoc b/docs/reference/indices/open-close.asciidoc index 3da1d3577e722..d568cbad3c875 100644 --- a/docs/reference/indices/open-close.asciidoc +++ b/docs/reference/indices/open-close.asciidoc @@ -80,6 +80,8 @@ or using the <> API. ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/indices/put-mapping.asciidoc b/docs/reference/indices/put-mapping.asciidoc index 62258d9f85e28..a3915b75174dc 100644 --- a/docs/reference/indices/put-mapping.asciidoc +++ b/docs/reference/indices/put-mapping.asciidoc @@ -47,6 +47,8 @@ To update the mapping of all indices, omit this parameter or use a value of ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `false`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/indices/refresh.asciidoc b/docs/reference/indices/refresh.asciidoc index 205cd69fd9df3..108fb79f37143 100644 --- a/docs/reference/indices/refresh.asciidoc +++ b/docs/reference/indices/refresh.asciidoc @@ -72,6 +72,8 @@ or use a value of `_all` or `*`. ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/indices/segments.asciidoc b/docs/reference/indices/segments.asciidoc index 3bdeaa8b648f6..09bdbe4b401bd 100644 --- a/docs/reference/indices/segments.asciidoc +++ b/docs/reference/indices/segments.asciidoc @@ -32,6 +32,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index] ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/indices/shard-stores.asciidoc b/docs/reference/indices/shard-stores.asciidoc index a1d3f7f224dd4..996332532bbc2 100644 --- a/docs/reference/indices/shard-stores.asciidoc +++ b/docs/reference/indices/shard-stores.asciidoc @@ -56,6 +56,8 @@ or omit this parameter. ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/indices/update-settings.asciidoc b/docs/reference/indices/update-settings.asciidoc index 71efd50c26eed..0593cc14929c0 100644 --- a/docs/reference/indices/update-settings.asciidoc +++ b/docs/reference/indices/update-settings.asciidoc @@ -37,6 +37,8 @@ use `_all` or exclude this parameter. ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `false`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/search/count.asciidoc b/docs/reference/search/count.asciidoc index 0948b37f1b0a0..ee825de01b829 100644 --- a/docs/reference/search/count.asciidoc +++ b/docs/reference/search/count.asciidoc @@ -44,6 +44,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index] ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer] diff --git a/docs/reference/search/field-caps.asciidoc b/docs/reference/search/field-caps.asciidoc index c6b945c055bf6..a460b02fa7cd9 100644 --- a/docs/reference/search/field-caps.asciidoc +++ b/docs/reference/search/field-caps.asciidoc @@ -39,6 +39,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index] ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/search/rank-eval.asciidoc b/docs/reference/search/rank-eval.asciidoc index 284e5a6f3d74a..3dec9d1d61f8f 100644 --- a/docs/reference/search/rank-eval.asciidoc +++ b/docs/reference/search/rank-eval.asciidoc @@ -69,6 +69,8 @@ generation in your application. ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/search/search-shards.asciidoc b/docs/reference/search/search-shards.asciidoc index 48c02a3e73f65..2c949cfe486df 100644 --- a/docs/reference/search/search-shards.asciidoc +++ b/docs/reference/search/search-shards.asciidoc @@ -35,6 +35,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index] ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] + diff --git a/docs/reference/search/search-template.asciidoc b/docs/reference/search/search-template.asciidoc index 0183213cd1fcc..4e866f4ffe4f4 100644 --- a/docs/reference/search/search-template.asciidoc +++ b/docs/reference/search/search-template.asciidoc @@ -53,6 +53,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index] ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `true`. `ccs_minimize_roundtrips`:: (Optional, boolean) If `true`, network round-trips are minimized for diff --git a/docs/reference/search/search.asciidoc b/docs/reference/search/search.asciidoc index be58e1478e942..b6c7ab5aae613 100644 --- a/docs/reference/search/search.asciidoc +++ b/docs/reference/search/search.asciidoc @@ -47,7 +47,9 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index] ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] - ++ +Defaults to `true`. + `allow_partial_search_results`:: (Optional, boolean) Indicates if an error should be returned if there is a partial search failure or timeout. Defaults to `true`. diff --git a/docs/reference/search/validate.asciidoc b/docs/reference/search/validate.asciidoc index c88ca44a4a3b9..ed9738cef4569 100644 --- a/docs/reference/search/validate.asciidoc +++ b/docs/reference/search/validate.asciidoc @@ -40,6 +40,8 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=query] instead of one random shard per index. Defaults to `false`. include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] ++ +Defaults to `false`. include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer]