Skip to content

Commit d9fbed5

Browse files
jrodewigprobakowski
authored andcommitted
[DOCS] Fix ignore_unavailable parameter definition (elastic#84071)
The current `ignore_unavailable` definition is a bit misleading. The parameter primarily determines if a request that targets a missing or closed index returns an error.
1 parent 939715c commit d9fbed5

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -109,8 +109,8 @@ Comma-separated list of filters for the API response. See
109109
<<common-options-response-filtering>>.
110110

111111
`ignore_unavailable`::
112-
(Optional, Boolean) If `true`, missing or closed indices are not included in the
113-
response. Defaults to `true`.
112+
(Optional, Boolean) If `false`, the request returns an error if it targets a
113+
missing or closed index. Defaults to `true`.
114114

115115
`keep_alive`::
116116
+

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -398,8 +398,8 @@ end::ignore_throttled[]
398398

399399
tag::index-ignore-unavailable[]
400400
`ignore_unavailable`::
401-
(Optional, Boolean) If `true`, missing or closed indices are not included in the
402-
response. Defaults to `false`.
401+
(Optional, Boolean) If `false`, the request returns an error if it targets a
402+
missing or closed index. Defaults to `false`.
403403
end::index-ignore-unavailable[]
404404

405405
tag::include-defaults[]

0 commit comments

Comments
 (0)