Skip to content

Commit 717efd7

Browse files
authored
[DOCS] Fix ignore_unavailable parameter definition (#84071) (#84110)
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 335b044 commit 717efd7

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

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

103103
`keep_alive`::
104104
+

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

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

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

425425
tag::include-defaults[]

0 commit comments

Comments
 (0)