[Docs] Clarify default value for allow_no_indices (#52635) (#52697)

Add default value to each one of the usages of `allow_no_indices`
since it differs between different APIs.

Relates to: #52534

(cherry picked from commit 2eb986488ac326d6da6ab8ad0203a94e08684a36)
This commit is contained in:
Marios Trivyzas 2020-02-24 11:57:32 +01:00 committed by GitHub
parent 225d841212
commit c03f51f68f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
28 changed files with 58 additions and 6 deletions

View File

@ -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

View File

@ -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]

View File

@ -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`.

View File

@ -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]
+

View File

@ -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]
+

View File

@ -43,6 +43,8 @@ or using the <<cluster-update-settings,cluster update settings>> 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]
+

View File

@ -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]
include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]

View File

@ -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]
+

View File

@ -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]
+

View File

@ -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]
+

View File

@ -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]

View File

@ -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]
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]

View File

@ -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]
+

View File

@ -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]
// TEST[continued]

View File

@ -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]
+

View File

@ -80,6 +80,8 @@ or using the <<cluster-update-settings,cluster update settings>> 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]
+

View File

@ -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]
+

View File

@ -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]
+

View File

@ -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]
+

View File

@ -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]
+

View File

@ -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]
+

View File

@ -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]

View File

@ -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]
+

View File

@ -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]
+

View File

@ -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]
+

View File

@ -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

View File

@ -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`.

View File

@ -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]