Skip to content

Commit

Permalink
[DOCS] Update alias references (elastic#73427) (elastic#73502)
Browse files Browse the repository at this point in the history
Updates several `index aliases` references to `aliases`.
  • Loading branch information
jrodewig authored May 27, 2021
1 parent f4ed047 commit 3182482
Show file tree
Hide file tree
Showing 46 changed files with 176 additions and 287 deletions.
10 changes: 5 additions & 5 deletions docs/reference/api-conventions.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,17 @@ 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 run a request on
multiple resources, such as data streams, indices, or index aliases:
multiple resources, such as data streams, indices, or 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.
IMPORTANT: 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:
Expand Down
13 changes: 5 additions & 8 deletions docs/reference/cat/count.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,19 +22,16 @@ which have not yet been removed by the merge process.
==== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have the `read`
<<privileges-list-indices,index privilege>> for any data stream, index, or index
alias you retrieve.
<<privileges-list-indices,index privilege>> for any data stream, index, or alias
you retrieve.

[[cat-count-api-path-params]]
==== {api-path-parms-title}

`<target>`::
(Optional, string)
Comma-separated list of data streams, indices, and index aliases used to limit
the request. Wildcard expressions (`*`) are supported.
+
To target all data streams and indices in a cluster, omit this parameter or use
`_all` or `*`.
(Optional, string) Comma-separated list of data streams, indices, and aliases
used to limit the request. Supports wildcards (`*`). To target all data streams
and indices, omit this parameter or use `*` or `_all`.

[[cat-count-api-query-params]]
==== {api-query-parms-title}
Expand Down
11 changes: 4 additions & 7 deletions docs/reference/cat/indices.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ indices for data streams.
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API. You must
also have the `monitor` or `manage` <<privileges-list-indices,index privilege>>
for any data stream, index, or index alias you retrieve.
for any data stream, index, or alias you retrieve.

[[cat-indices-api-desc]]
==== {api-description-title}
Expand All @@ -48,12 +48,9 @@ To get an accurate count of {es} documents, use the <<cat-count,cat count>> or
==== {api-path-parms-title}

`<target>`::
(Optional, string)
Comma-separated list of data streams, indices, and index aliases used to limit
the request. Wildcard expressions (`*`) are supported.
+
To target all data streams and indices in a cluster, omit this parameter or use
`_all` or `*`.
(Optional, string) Comma-separated list of data streams, indices, and aliases
used to limit the request. Supports wildcards (`*`). To target all data streams
and indices, omit this parameter or use `*` or `_all`.

[[cat-indices-api-query-params]]
==== {api-query-parms-title}
Expand Down
12 changes: 4 additions & 8 deletions docs/reference/cat/recovery.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ indices.
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API. You must
also have the `monitor` or `manage` <<privileges-list-indices,index privilege>>
for any data stream, index, or index alias you retrieve.
for any data stream, index, or alias you retrieve.

[[cat-recovery-api-desc]]
==== {api-description-title}
Expand All @@ -40,13 +40,9 @@ include::{es-repo-dir}/indices/recovery.asciidoc[tag=shard-recovery-desc]
==== {api-path-parms-title}

`<target>`::
(Optional, string)
Comma-separated list of data streams, indices, and index aliases used to limit
the request. Wildcard expressions (`*`) are supported.
+
To target all data streams and indices in a cluster, omit this parameter or use
`_all` or `*`.

(Optional, string) Comma-separated list of data streams, indices, and aliases
used to limit the request. Supports wildcards (`*`). To target all data streams
and indices, omit this parameter or use `*` or `_all`.

[[cat-recovery-query-params]]
==== {api-query-parms-title}
Expand Down
11 changes: 4 additions & 7 deletions docs/reference/cat/segments.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,15 @@ indices.
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API. You must
also have the `monitor` or `manage` <<privileges-list-indices,index privilege>>
for any data stream, index, or index alias you retrieve.
for any data stream, index, or alias you retrieve.

[[cat-segments-path-params]]
==== {api-path-parms-title}

`<target>`::
(Optional, string)
Comma-separated list of data streams, indices, and index aliases used to limit
the request. Wildcard expressions (`*`) are supported.
+
To target all data streams and indices in a cluster, omit this parameter or use
`_all` or `*`.
(Optional, string) Comma-separated list of data streams, indices, and aliases
used to limit the request. Supports wildcards (`*`). To target all data streams
and indices, omit this parameter or use `*` or `_all`.

[[cat-segments-query-params]]
==== {api-query-parms-title}
Expand Down
11 changes: 4 additions & 7 deletions docs/reference/cat/shards.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,18 +25,15 @@ indices.
* If the {es} {security-features} are enabled, you must have the `monitor` or
`manage` <<privileges-list-cluster,cluster privilege>> to use this API. You must
also have the `monitor` or `manage` <<privileges-list-indices,index privilege>>
for any data stream, index, or index alias you retrieve.
for any data stream, index, or alias you retrieve.

[[cat-shards-path-params]]
==== {api-path-parms-title}

`<target>`::
(Optional, string)
Comma-separated list of data streams, indices, and index aliases used to limit
the request. Wildcard expressions (`*`) are supported.
+
To target all data streams and indices in a cluster, omit this parameter or use
`_all` or `*`.
(Optional, string) Comma-separated list of data streams, indices, and aliases
used to limit the request. Supports wildcards (`*`). To target all data streams
and indices, omit this parameter or use `*` or `_all`.

[[cat-shards-query-params]]
==== {api-query-parms-title}
Expand Down
10 changes: 3 additions & 7 deletions docs/reference/cluster/state.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -93,13 +93,9 @@ you can request only the part of the cluster state that you need:
--

`<target>`::
(Optional, string)
Comma-separated list of data streams, indices, and index aliases used to limit
the request. Wildcard expressions (`*`) are supported.
+
To target all data streams and indices in a cluster, omit this parameter or use
`_all` or `*`.

(Optional, string) Comma-separated list of data streams, indices, and aliases
used to limit the request. Supports wildcards (`*`). To target all data streams
and indices, omit this parameter or use `*` or `_all`.

[[cluster-state-api-query-params]]
==== {api-query-parms-title}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -386,10 +386,10 @@ Follow these steps:
stream will contain data from your existing stream.
+
You can use the resolve index API to check if the name or pattern matches any
existing indices, index aliases, or data streams. If so, you should consider
using another name or pattern.
existing indices, aliases, or data streams. If so, you should consider using
another name or pattern.
--
The following resolve index API request checks for any existing indices, index
The following resolve index API request checks for any existing indices,
aliases, or data streams that start with `new-data-stream`. If not, the
`new-data-stream*` index pattern can be used to create a new data stream.

Expand Down
4 changes: 2 additions & 2 deletions docs/reference/data-streams/use-a-data-stream.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,8 @@ POST /my-data-stream/_open/
[[reindex-with-a-data-stream]]
=== Reindex with a data stream

Use the <<docs-reindex,reindex API>> to copy documents from an
existing index, index alias, or data stream to a data stream. Because data streams are
Use the <<docs-reindex,reindex API>> to copy documents from an existing index,
alias, or data stream to a data stream. Because data streams are
<<data-streams-append-only,append-only>>, a reindex into a data stream must use
an `op_type` of `create`. A reindex cannot update existing documents in a data
stream.
Expand Down
11 changes: 4 additions & 7 deletions docs/reference/docs/delete-by-query.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ POST /my-index-000001/_delete_by_query

* If the {es} {security-features} are enabled, you must have the following
<<privileges-list-indices,index privileges>> for the target data stream, index,
or index alias:
or alias:

** `read`
** `delete` or `write`
Expand Down Expand Up @@ -168,12 +168,9 @@ documents being reindexed and cluster resources.
==== {api-path-parms-title}

`<target>`::
(Optional, string)
Comma-separated list of data streams, indices, and index aliases to search.
Wildcard (`*`) expressions are supported.
+
To search all data streams or indices in a cluster, omit this parameter or use
`_all` or `*`.
(Optional, string) Comma-separated list of data streams, indices, and aliases to
search. Supports wildcards (`*`). To search all data streams or indices, omit
this parameter or use `* or `_all`.

[[docs-delete-by-query-api-query-params]]
==== {api-query-parms-title}
Expand Down
10 changes: 5 additions & 5 deletions docs/reference/docs/reindex.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -75,18 +75,18 @@ POST _reindex
security privileges:

** The `read` <<privileges-list-indices,index privilege>> for the source data
stream, index, or index alias.
stream, index, or alias.

** The `write` index privilege for the destination data stream, index, or index
alias.

** To automatically create a data stream or index with an reindex API request,
you must have the `auto_configure`, `create_index`, or `manage` index
privilege for the destination data stream, index, or index alias.
privilege for the destination data stream, index, or alias.

** If reindexing from a remote cluster, the `source.remote.user` must have the
`monitor` <<privileges-list-cluster,cluster privilege>> and the `read` index
privilege for the source data stream, index, or index alias.
privilege for the source data stream, index, or alias.

* If reindexing from a remote cluster, you must explicitly allow the remote host
in the `reindex.remote.whitelist` setting of `elasticsearch.yml`. See
Expand Down Expand Up @@ -507,8 +507,8 @@ Defaults to `abort`.

`source`::
`index`:::
(Required, string) The name of the data stream, index, or index alias you are copying _from_.
Also accepts a comma-separated list to reindex from multiple sources.
(Required, string) The name of the data stream, index, or alias you are copying
_from_. Also accepts a comma-separated list to reindex from multiple sources.

`max_docs`:::
(Optional, integer) The maximum number of documents to reindex. If <<conflicts, conflicts>> is equal to
Expand Down
11 changes: 4 additions & 7 deletions docs/reference/docs/update-by-query.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ POST my-index-000001/_update_by_query?conflicts=proceed

* If the {es} {security-features} are enabled, you must have the following
<<privileges-list-indices,index privileges>> for the target data stream, index,
or index alias:
or alias:

** `read`
** `index` or `write`
Expand Down Expand Up @@ -162,12 +162,9 @@ documents being reindexed and cluster resources.
==== {api-path-parms-title}

`<target>`::
(Optional, string)
Comma-separated list of data streams, indices, and index aliases to search.
Wildcard (`*`) expressions are supported.
+
To search all data streams or indices in a cluster, omit this parameter or use
`_all` or `*`.
(Optional, string) Comma-separated list of data streams, indices, and aliases to
search. Supports wildcards (`*`). To search all data streams or indices, omit
this parameter or use `*` or `_all`.

[[docs-update-by-query-api-query-params]]
==== {api-query-parms-title}
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/eql/eql-search-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ GET /my-data-stream/_eql/search

* If the {es} {security-features} are enabled, you must have the `read`
<<privileges-list-indices,index privilege>> for the target data stream, index,
or index alias.
or alias.

* See <<eql-required-fields>>.

Expand Down
8 changes: 3 additions & 5 deletions docs/reference/ilm/apis/explain.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,9 @@ about any failures.
==== {api-path-parms-title}

`<target>`::
(Required, string)
Comma-separated list of data streams, indices, and index aliases to target.
Wildcard expressions (`*`) are supported.
+
To target all data streams and indices in a cluster, use `_all` or `*`.
(Required, string) Comma-separated list of data streams, indices, and aliases to
target. Supports wildcards (`*`).To target all data streams and indices, use `*`
or `_all`.

[[ilm-explain-lifecycle-query-params]]
==== {api-query-parms-title}
Expand Down
8 changes: 3 additions & 5 deletions docs/reference/ilm/apis/remove-policy-from-index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,9 @@ the stream's backing indices and stops managing the indices.
==== {api-path-parms-title}

`<target>`::
(Required, string)
Comma-separated list of data streams, indices, and index aliases to target.
Wildcard expressions (`*`) are supported.
+
To target all data streams and indices in a cluster, use `_all` or `*`.
(Required, string) Comma-separated list of data streams, indices, and aliases to
target. Supports wildcards (`*`). To target all data streams and indices, use
`*` or `_all`.

[[ilm-remove-policy-query-params]]
==== {api-query-parms-title}
Expand Down
11 changes: 4 additions & 7 deletions docs/reference/indices/apis/reload-analyzers.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ IMPORTANT: After reloading the search analyzers you should clear the request

* If the {es} {security-features} are enabled, you must have the `manage`
<<privileges-list-indices,index privilege>> for the target data stream, index,
or index alias.
or alias.

[discrete]
[[indices-reload-analyzers-api-desc]]
Expand Down Expand Up @@ -78,12 +78,9 @@ in the future.
=== {api-path-parms-title}

`<target>`::
(Required, string)
Comma-separated list of data streams, indices, and index aliases used to limit
the request. Wildcard expressions (`*`) are supported.
+
To target all data streams and indices in a cluster, use `_all` or `*`.

(Required, string) Comma-separated list of data streams, indices, and aliases
used to limit the request. Supports wildcards (`*`). To target all data streams
and indices, use `*` or `_all`.

[discrete]
[[indices-reload-analyzers-api-query-params]]
Expand Down
12 changes: 4 additions & 8 deletions docs/reference/indices/clearcache.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -26,19 +26,15 @@ POST /my-index-000001/_cache/clear

* If the {es} {security-features} are enabled, you must have the `manage`
<<privileges-list-indices,index privilege>> for the target data stream, index,
or index alias.
or alias.

[[clear-cache-api-path-params]]
==== {api-path-parms-title}

`<target>`::
(Optional, string)
Comma-separated list of data streams, indices, and index aliases used to limit
the request. Wildcard expressions (`*`) are supported.
+
To target all data streams and indices in a cluster, omit this parameter or use
`_all` or `*`.

(Optional, string) Comma-separated list of data streams, indices, and aliases
used to limit the request. Supports wildcards (`*`). To target all data streams
and indices, omit this parameter or use `*` or `_all`.

[[clear-cache-api-query-params]]
==== {api-query-parms-title}
Expand Down
12 changes: 4 additions & 8 deletions docs/reference/indices/flush.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ POST /my-index-000001/_flush

* If the {es} {security-features} are enabled, you must have the `maintenance`
or `manage` <<privileges-list-indices,index privilege>> for the target data
stream, index, or index alias.
stream, index, or alias.

[[flush-api-desc]]
==== {api-description-title}
Expand Down Expand Up @@ -60,13 +60,9 @@ flush API was called.
==== {api-path-parms-title}

`<target>`::
(Optional, string)
Comma-separated list of data streams, indices, and index aliases to flush.
Wildcard expressions (`*`) are supported.
+
To flush all data streams and indices in a cluster, omit this parameter or use
`_all` or `*`.

(Optional, string) Comma-separated list of data streams, indices, and aliases to
flush. Supports wildcards (`*`). To flush all data streams and indices, omit
this parameter or use `*` or `_all`.

[[flush-api-query-params]]
==== {api-query-parms-title}
Expand Down
Loading

0 comments on commit 3182482

Please sign in to comment.