Skip to content

Commit 4da1063

Browse files
jrodewigAdam Locke
and
Adam Locke
authored
[DOCS] EQL: Update allow_no_indices default (#63748) (#63890)
Co-authored-by: Adam Locke <[email protected]>
1 parent abe4aaa commit 4da1063

File tree

2 files changed

+24
-5
lines changed

2 files changed

+24
-5
lines changed

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

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,25 @@ To search all data streams and indices in a cluster, use
5656
[[eql-search-api-query-params]]
5757
==== {api-query-parms-title}
5858

59-
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=allow-no-indices]
59+
`allow_no_indices`::
60+
(Optional, boolean)
61+
+
62+
NOTE: This parameter's behavior differs from the `allow_no_indices` parameter
63+
used in other <<multi-index,multi-target APIs>>.
64+
+
65+
If `false`, the request returns an error if any wildcard expression,
66+
<<indices-aliases,index alias>>, or `_all` value targets only missing or closed
67+
indices. This behavior applies even if the request targets other open indices.
68+
For example, a request targeting `foo*,bar*` returns an error if an index
69+
starts with `foo` but no index starts with `bar`.
6070
+
61-
Defaults to `false`.
71+
If `true`, only requests that exclusively target missing or closed indices
72+
return an error. For example, a request targeting `foo*,bar*` does not return an
73+
error if an index starts with `foo` but no index starts with `bar`. However, a
74+
request that targets only `bar*` still returns an error.
75+
+
76+
Defaults to `true`.
77+
6278

6379
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
6480
+

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

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,12 @@ end::target-index-aliases[]
4848

4949
tag::allow-no-indices[]
5050
`allow_no_indices`::
51-
(Optional, boolean) If `false`, the request returns an error when a
52-
wildcard expression, <<indices-aliases,index alias>>, or `_all` value targets
53-
only missing or closed indices.
51+
(Optional, boolean)
52+
If `false`, the request returns an error if any wildcard expression,
53+
<<indices-aliases,index alias>>, or `_all` value targets only missing or closed
54+
indices. This behavior applies even if the request targets other open indices.
55+
For example, a request targeting `foo*,bar*` returns an error if an index
56+
starts with `foo` but no index starts with `bar`.
5457
end::allow-no-indices[]
5558

5659
tag::allow-no-match-transforms1[]

0 commit comments

Comments
 (0)