honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[7.x] [DOCS] Update multi-target syntax page (#62192) (#62195) 

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>

Co-authored-by: Nicole Albee <2642763+a03nikki@users.noreply.github.com>
This commit is contained in:
James Rodewig 2020-09-09 18:24:33 -04:00 committed by GitHub
parent c6c6596623
commit 71ca7f4d70
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/reference/api-conventions.asciidoc
View File

@ -18,14 +18,19 @@ API, unless otherwise specified.
Most APIs that accept a `<data-stream>`, `<index>`, or `<target>` request path
parameter also support _multi-target syntax_.
In multi-target syntax, you can use a comma-separated list to execute a request across multiple resources, such as
data streams, indices, or index aliases: `test1,test2,test3`. You can also use
{wikipedia}/Glob_(programming)[glob-like] wildcard (`*`)
expressions to target any
resources that match the pattern: `test*` or `*test` or `te*t` or `*test*.
In multi-target syntax, you can use a comma-separated list to run a request on
multiple resources, such as data streams, indices, or index aliases:
`test1,test2,test3`. You can also use {wikipedia}/Glob_(programming)[glob-like]
wildcard (`*`) expressions to target resources that match a pattern: `test*` or
`*test` or `te*t` or `*test*`.
You can exclude targets using the `-` character: `test*,-test3`.
IMPORTANT: Index aliases are resolved after wildcard expressions. This can
result in a request that targets an excluded alias. For example, if `test3` is
an index alias, the pattern `test*,-test3` still targets the indices for
`test3`. To avoid this, exclude the concrete indices for the alias instead.
Multi-target APIs that can target indices support the following query
string parameters: