Skip to content

[7.x] [DOCS] Update wildcard support for removing aliases (#74561) #74626

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 28, 2021
Merged

[7.x] [DOCS] Update wildcard support for removing aliases (#74561) #74626

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 12 additions & 8 deletions docs/reference/indices/aliases.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,14 +80,16 @@ The object body contains options for the alias. Supports an empty object.
`alias`::
(Required*, string) Alias for the action. Index alias names support
<<date-math-index-names,date math>>. If `aliases` is not specified, the `add`
and `remove` actions require this parameter. The `remove_index` action doesn't
support this parameter.
and `remove` actions require this parameter. For the `remove` action, this
parameter supports wildcards (`*`). The `remove_index` action doesn't support
this parameter.

`aliases`::
(Required*, array of strings) Aliases for the action. Index alias names support
<<date-math-index-names,date math>>. If `alias` is not specified, the `add` and
`remove` actions require this parameter. The `remove_index` action doesn't
support this parameter.
`remove` actions require this parameter. For the `remove` action, this parameter
supports wildcards (`*`). The `remove_index` action doesn't support this
parameter.

// tag::alias-options[]
`filter`::
Expand All @@ -99,13 +101,15 @@ Only the `add` action supports this parameter.

`index`::
(Required*, string) Data stream or index for the action. Supports wildcards
(`*`). Wildcard patterns that match both data streams and indices return an
error. If `indices` is not specified, this parameter is required.
(`*`). If `indices` is not specified, this parameter is required. For the `add`
and `remove_index` actions, wildcard patterns that match both data streams and
indices return an error.

`indices`::
(Required*, array of strings) Data streams or indices for the action. Supports
wildcards (`*`). Wildcard patterns that match both data streams and indices
return an error. If `index` is not specified, this parameter is required.
wildcards (`*`). If `index` is not specified, this parameter is required. For
the `add` and `remove_index` actions, wildcard patterns that match both data
streams and indices return an error.

// tag::alias-options[]
`index_routing`::
Expand Down
3 changes: 1 addition & 2 deletions docs/reference/indices/delete-alias.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,7 @@ indices.

`<target>`::
(Required, string) Comma-separated list of data streams or indices used to limit
the request. Supports wildcards (`*`). Wildcard patterns that match both data
streams and indices return an error.
the request. Supports wildcards (`*`).

[[delete-alias-api-query-params]]
==== {api-query-parms-title}
Expand Down