Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 24, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/reference/cluster/state.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/docs/delete-by-query.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
2 changes: 0 additions & 2 deletions docs/reference/indices/alias-exists.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/indices/apis/reload-analyzers.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/indices/clearcache.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/indices/close.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
4 changes: 3 additions & 1 deletion docs/reference/indices/delete-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,13 @@ 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]
+
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]
2 changes: 2 additions & 0 deletions docs/reference/indices/flush.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/indices/forcemerge.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/indices/get-alias.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/indices/get-field-mapping.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
4 changes: 3 additions & 1 deletion docs/reference/indices/get-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand All @@ -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]
2 changes: 2 additions & 0 deletions docs/reference/indices/get-mapping.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
4 changes: 3 additions & 1 deletion docs/reference/indices/get-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down Expand Up @@ -82,4 +84,4 @@ as follows:
--------------------------------------------------
GET /log_2013_-*/_settings/index.number_*
--------------------------------------------------
// TEST[continued]
// TEST[continued]
2 changes: 2 additions & 0 deletions docs/reference/indices/indices-exists.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/indices/open-close.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/indices/put-mapping.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/indices/refresh.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/indices/segments.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/indices/shard-stores.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/indices/update-settings.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/search/count.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
2 changes: 2 additions & 0 deletions docs/reference/search/field-caps.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/search/rank-eval.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/search/search-shards.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
+
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/search/search-template.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 3 additions & 1 deletion docs/reference/search/search.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/search/validate.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down