Skip to content

Commit 6be6fcd

Browse files
[DOCS] Mark 'ignore_throttled' deprecated in all docs (#101838) (#101870)
1 parent d21d5bc commit 6be6fcd

File tree

7 files changed

+9
-16
lines changed

7 files changed

+9
-16
lines changed

docs/reference/indices/resolve.asciidoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -88,9 +88,11 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
8888
+
8989
Defaults to `true`.
9090

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

9597
[[resolve-index-api-example]]
9698
==== {api-examples-title}

docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,6 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
6666
Defaults to `open`.
6767

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

7270
`ignore_unavailable`::
7371
(Optional, Boolean) If `true`, unavailable indices (missing or closed) are

docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,6 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
5555
Defaults to `open`.
5656

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

6159
`ignore_unavailable`::
6260
(Optional, Boolean) If `true`, unavailable indices (missing or closed) are

docs/reference/rest-api/common-parms.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -438,6 +438,8 @@ tag::ignore_throttled[]
438438
`ignore_throttled`::
439439
(Optional, Boolean) If `true`, concrete, expanded or aliased indices are
440440
ignored when frozen. Defaults to `true`.
441+
+
442+
deprecated:[7.16.0]
441443
end::ignore_throttled[]
442444

443445
tag::index-ignore-unavailable[]

docs/reference/search/multi-search.asciidoc

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,10 +84,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
8484
+
8585
Defaults to `open`.
8686

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

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

docs/reference/search/search-template-api.asciidoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,9 +92,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
9292
(Optional, Boolean) If `true`, the response includes additional details about
9393
score computation as part of a hit. Defaults to `false`.
9494

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

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

docs/reference/search/search.asciidoc

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,7 @@ By default, you cannot page through more than 10,000 hits using the `from` and
109109
`size` parameters. To page through more hits, use the
110110
<<search-after,`search_after`>> parameter.
111111

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

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

0 commit comments

Comments
 (0)