Skip to content

Commit bbd31b7

Browse files
authored
[DOCS] Fix ignore_unavailable parameter definition (#84071) (#84112)
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. (cherry picked from commit f9a64b2)
1 parent d7548d0 commit bbd31b7

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
@@ -88,8 +88,8 @@ Comma-separated list of filters for the API response. See
8888
<<common-options-response-filtering>>.
8989

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

9494
`keep_alive`::
9595
+

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

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

423423
tag::index-ignore-unavailable[]
424424
`ignore_unavailable`::
425-
(Optional, Boolean) If `true`, missing or closed indices are not included in the
426-
response. Defaults to `false`.
425+
(Optional, Boolean) If `false`, the request returns an error if it targets a
426+
missing or closed index. Defaults to `false`.
427427
end::index-ignore-unavailable[]
428428

429429
tag::include-defaults[]

0 commit comments

Comments
 (0)