Skip to content

Commit

Permalink
[DOCS] Fix ignore_unavailable parameter definition (elastic#84071)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jrodewig authored and probakowski committed Feb 23, 2022
1 parent 939715c commit d9fbed5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/reference/eql/eql-search-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -109,8 +109,8 @@ Comma-separated list of filters for the API response. See
<<common-options-response-filtering>>.

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

`keep_alive`::
+
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/rest-api/common-parms.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -398,8 +398,8 @@ end::ignore_throttled[]

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

tag::include-defaults[]
Expand Down

0 comments on commit d9fbed5

Please sign in to comment.