Skip to content

[8.11] [DOCS] Mark 'ignore_throttled' deprecated in all docs (#101838) #101869

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.

Sign up for GitHub

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
Nov 7, 2023
Merged

[8.11] [DOCS] Mark 'ignore_throttled' deprecated in all docs (#101838) #101869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 4 additions & 2 deletions docs/reference/indices/resolve.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,9 +88,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
+
Defaults to `true`.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled]
`ignore_throttled`::
(Optional, Boolean) If `true`, concrete, expanded or aliased indices are
ignored when frozen. Defaults to `false`.
+
Defaults to `false`.
deprecated:[7.16.0]

[[resolve-index-api-example]]
==== {api-examples-title}
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,6 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
Defaults to `open`.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled]
+
deprecated:[7.16.0]

`ignore_unavailable`::
(Optional, Boolean) If `true`, unavailable indices (missing or closed) are
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,6 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
Defaults to `open`.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled]
+
deprecated:[7.16.0]

`ignore_unavailable`::
(Optional, Boolean) If `true`, unavailable indices (missing or closed) are
Expand Down
2 changes: 2 additions & 0 deletions docs/reference/rest-api/common-parms.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -438,6 +438,8 @@ tag::ignore_throttled[]
`ignore_throttled`::
(Optional, Boolean) If `true`, concrete, expanded or aliased indices are
ignored when frozen. Defaults to `true`.
+
deprecated:[7.16.0]
end::ignore_throttled[]

tag::index-ignore-unavailable[]
Expand Down
5 changes: 1 addition & 4 deletions docs/reference/search/multi-search.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,10 +84,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
+
Defaults to `open`.

`ignore_throttled`::
(Optional, Boolean)
If `true`, concrete, expanded or aliased indices are ignored when frozen.
Defaults to `true`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled]

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]

Expand Down
4 changes: 1 addition & 3 deletions docs/reference/search/search-template-api.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,9 +92,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
(Optional, Boolean) If `true`, the response includes additional details about
score computation as part of a hit. Defaults to `false`.

`ignore_throttled`::
(Optional, Boolean) If `true`, specified concrete, expanded, or aliased indices
are not included in the response when throttled. Defaults to `true`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled]

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]

Expand Down
4 changes: 1 addition & 3 deletions docs/reference/search/search.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,9 +109,7 @@ By default, you cannot page through more than 10,000 hits using the `from` and
`size` parameters. To page through more hits, use the
<<search-after,`search_after`>> parameter.

`ignore_throttled`::
(Optional, Boolean) If `true`, concrete, expanded or aliased indices will be
ignored when frozen. Defaults to `true`.
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=ignore_throttled]

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]

Expand Down