Browse Source

[DOCS] Update wildcard support for removing aliases (#74561)

You can now use a wildcard pattern to remove data stream and index
aliases in the same action/request.

Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>
James Rodewig 4 years ago
parent
commit
ed1999e935

+ 12 - 8
docs/reference/indices/aliases.asciidoc

@@ -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`::
@@ -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`::

+ 1 - 2
docs/reference/indices/delete-alias.asciidoc

@@ -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}