From 965ca6475f2b4a6dcf25c6c6497433eec2f6da8b Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Thu, 17 Feb 2022 08:24:06 -0500 Subject: [PATCH] [DOCS] Fix `ignore_unavailable` parameter definition (#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. (cherry picked from commit f9a64b2e8685a95fe27b89daefbe898668298b13) --- docs/reference/eql/eql-search-api.asciidoc | 4 ++-- docs/reference/rest-api/common-parms.asciidoc | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/reference/eql/eql-search-api.asciidoc b/docs/reference/eql/eql-search-api.asciidoc index 1f545842579a6..e18c30917c261 100644 --- a/docs/reference/eql/eql-search-api.asciidoc +++ b/docs/reference/eql/eql-search-api.asciidoc @@ -97,8 +97,8 @@ Comma-separated list of filters for the API response. See <>. `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`:: + diff --git a/docs/reference/rest-api/common-parms.asciidoc b/docs/reference/rest-api/common-parms.asciidoc index 34b4ff6efaf7c..12192de9f51bf 100644 --- a/docs/reference/rest-api/common-parms.asciidoc +++ b/docs/reference/rest-api/common-parms.asciidoc @@ -418,8 +418,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[]