Skip to content

Commit 23f3de4

Browse files
jrodewiga03nikki
andauthored
[DOCS] Update multi-target syntax page (#62192) (#62196)
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com> Co-authored-by: Nicole Albee <2642763+a03nikki@users.noreply.github.com>
1 parent f00c918 commit 23f3de4

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

docs/reference/api-conventions.asciidoc

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,19 @@ API, unless otherwise specified.
1818
Most APIs that accept a `<data-stream>`, `<index>`, or `<target>` request path
1919
parameter also support _multi-target syntax_.
2020

21-
In multi-target syntax, you can use a comma-separated list to execute a request across multiple resources, such as
22-
data streams, indices, or index aliases: `test1,test2,test3`. You can also use
23-
{wikipedia}/Glob_(programming)[glob-like] wildcard (`*`)
24-
expressions to target any
25-
resources that match the pattern: `test*` or `*test` or `te*t` or `*test*.
21+
In multi-target syntax, you can use a comma-separated list to run a request on
22+
multiple resources, such as data streams, indices, or index aliases:
23+
`test1,test2,test3`. You can also use {wikipedia}/Glob_(programming)[glob-like]
24+
wildcard (`*`) expressions to target resources that match a pattern: `test*` or
25+
`*test` or `te*t` or `*test*`.
2626

2727
You can exclude targets using the `-` character: `test*,-test3`.
2828

29+
IMPORTANT: Index aliases are resolved after wildcard expressions. This can
30+
result in a request that targets an excluded alias. For example, if `test3` is
31+
an index alias, the pattern `test*,-test3` still targets the indices for
32+
`test3`. To avoid this, exclude the concrete indices for the alias instead.
33+
2934
Multi-target APIs that can target indices support the following query
3035
string parameters:
3136

0 commit comments

Comments
 (0)