Skip to content

Commit 5729bb8

Browse files
authored
[DOCS] Update alias references (#73427)
Updates several `index aliases` references to `aliases`.
1 parent 0aa0171 commit 5729bb8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+178
-288
lines changed

docs/reference/api-conventions.asciidoc

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

2121
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:
22+
multiple resources, such as data streams, indices, or aliases:
2323
`test1,test2,test3`. You can also use {wikipedia}/Glob_(programming)[glob-like]
2424
wildcard (`*`) expressions to target resources that match a pattern: `test*` or
2525
`*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.
29+
IMPORTANT: Aliases are resolved after wildcard expressions. This can result in a
30+
request that targets an excluded alias. For example, if `test3` is an index
31+
alias, the pattern `test*,-test3` still targets the indices for `test3`. To
32+
avoid this, exclude the concrete indices for the alias instead.
3333

3434
Multi-target APIs that can target indices support the following query
3535
string parameters:

docs/reference/cat/count.asciidoc

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,16 @@ which have not yet been removed by the merge process.
2222
==== {api-prereq-title}
2323

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

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

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

3936
[[cat-count-api-query-params]]
4037
==== {api-query-parms-title}

docs/reference/cat/indices.asciidoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ indices for data streams.
2121
* If the {es} {security-features} are enabled, you must have the `monitor` or
2222
`manage` <<privileges-list-cluster,cluster privilege>> to use this API. You must
2323
also have the `monitor` or `manage` <<privileges-list-indices,index privilege>>
24-
for any data stream, index, or index alias you retrieve.
24+
for any data stream, index, or alias you retrieve.
2525

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

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

5855
[[cat-indices-api-query-params]]
5956
==== {api-query-parms-title}

docs/reference/cat/recovery.asciidoc

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ indices.
2424
* If the {es} {security-features} are enabled, you must have the `monitor` or
2525
`manage` <<privileges-list-cluster,cluster privilege>> to use this API. You must
2626
also have the `monitor` or `manage` <<privileges-list-indices,index privilege>>
27-
for any data stream, index, or index alias you retrieve.
27+
for any data stream, index, or alias you retrieve.
2828

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

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

5147
[[cat-recovery-query-params]]
5248
==== {api-query-parms-title}

docs/reference/cat/segments.asciidoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,18 +24,15 @@ indices.
2424
* If the {es} {security-features} are enabled, you must have the `monitor` or
2525
`manage` <<privileges-list-cluster,cluster privilege>> to use this API. You must
2626
also have the `monitor` or `manage` <<privileges-list-indices,index privilege>>
27-
for any data stream, index, or index alias you retrieve.
27+
for any data stream, index, or alias you retrieve.
2828

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

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

4037
[[cat-segments-query-params]]
4138
==== {api-query-parms-title}

docs/reference/cat/shards.asciidoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,18 +25,15 @@ indices.
2525
* If the {es} {security-features} are enabled, you must have the `monitor` or
2626
`manage` <<privileges-list-cluster,cluster privilege>> to use this API. You must
2727
also have the `monitor` or `manage` <<privileges-list-indices,index privilege>>
28-
for any data stream, index, or index alias you retrieve.
28+
for any data stream, index, or alias you retrieve.
2929

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

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

4138
[[cat-shards-query-params]]
4239
==== {api-query-parms-title}

docs/reference/cluster/state.asciidoc

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,9 @@ you can request only the part of the cluster state that you need:
9393
--
9494

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

104100
[[cluster-state-api-query-params]]
105101
==== {api-query-parms-title}

docs/reference/data-streams/change-mappings-and-settings.asciidoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -386,10 +386,10 @@ Follow these steps:
386386
stream will contain data from your existing stream.
387387
+
388388
You can use the resolve index API to check if the name or pattern matches any
389-
existing indices, index aliases, or data streams. If so, you should consider
390-
using another name or pattern.
389+
existing indices, aliases, or data streams. If so, you should consider using
390+
another name or pattern.
391391
--
392-
The following resolve index API request checks for any existing indices, index
392+
The following resolve index API request checks for any existing indices,
393393
aliases, or data streams that start with `new-data-stream`. If not, the
394394
`new-data-stream*` index pattern can be used to create a new data stream.
395395

docs/reference/data-streams/use-a-data-stream.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,8 +154,8 @@ POST /my-data-stream/_open/
154154
[[reindex-with-a-data-stream]]
155155
=== Reindex with a data stream
156156

157-
Use the <<docs-reindex,reindex API>> to copy documents from an
158-
existing index, index alias, or data stream to a data stream. Because data streams are
157+
Use the <<docs-reindex,reindex API>> to copy documents from an existing index,
158+
alias, or data stream to a data stream. Because data streams are
159159
<<data-streams-append-only,append-only>>, a reindex into a data stream must use
160160
an `op_type` of `create`. A reindex cannot update existing documents in a data
161161
stream.

docs/reference/docs/delete-by-query.asciidoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ POST /my-index-000001/_delete_by_query
5454

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

5959
** `read`
6060
** `delete` or `write`
@@ -168,12 +168,9 @@ documents being reindexed and cluster resources.
168168
==== {api-path-parms-title}
169169

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

178175
[[docs-delete-by-query-api-query-params]]
179176
==== {api-query-parms-title}

docs/reference/docs/reindex.asciidoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,18 +75,18 @@ POST _reindex
7575
security privileges:
7676

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

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

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

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

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

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

513513
`max_docs`:::
514514
(Optional, integer) The maximum number of documents to reindex. If <<conflicts, conflicts>> is equal to

docs/reference/docs/update-by-query.asciidoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ POST my-index-000001/_update_by_query?conflicts=proceed
5151

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

5656
** `read`
5757
** `index` or `write`
@@ -162,12 +162,9 @@ documents being reindexed and cluster resources.
162162
==== {api-path-parms-title}
163163

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

172169
[[docs-update-by-query-api-query-params]]
173170
==== {api-query-parms-title}

docs/reference/eql/eql-search-api.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ GET /my-data-stream/_eql/search
4444

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

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

docs/reference/ilm/apis/explain.asciidoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,9 @@ about any failures.
3434
==== {api-path-parms-title}
3535

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

4341
[[ilm-explain-lifecycle-query-params]]
4442
==== {api-query-parms-title}

docs/reference/ilm/apis/remove-policy-from-index.asciidoc

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,9 @@ the stream's backing indices and stops managing the indices.
3434
==== {api-path-parms-title}
3535

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

4341
[[ilm-remove-policy-query-params]]
4442
==== {api-query-parms-title}

docs/reference/indices/apis/reload-analyzers.asciidoc

Lines changed: 4 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ IMPORTANT: After reloading the search analyzers you should clear the request
3535

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

4040
[discrete]
4141
[[indices-reload-analyzers-api-desc]]
@@ -78,12 +78,9 @@ in the future.
7878
=== {api-path-parms-title}
7979

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

8885
[discrete]
8986
[[indices-reload-analyzers-api-query-params]]

docs/reference/indices/clearcache.asciidoc

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,19 +26,15 @@ POST /my-index-000001/_cache/clear
2626

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

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

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

4339
[[clear-cache-api-query-params]]
4440
==== {api-query-parms-title}

docs/reference/indices/flush.asciidoc

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ POST /my-index-000001/_flush
2929

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

3434
[[flush-api-desc]]
3535
==== {api-description-title}
@@ -59,13 +59,9 @@ flush API was called.
5959
==== {api-path-parms-title}
6060

6161
`<target>`::
62-
(Optional, string)
63-
Comma-separated list of data streams, indices, and index aliases to flush.
64-
Wildcard expressions (`*`) are supported.
65-
+
66-
To flush all data streams and indices in a cluster, omit this parameter or use
67-
`_all` or `*`.
68-
62+
(Optional, string) Comma-separated list of data streams, indices, and aliases to
63+
flush. Supports wildcards (`*`). To flush all data streams and indices, omit
64+
this parameter or use `*` or `_all`.
6965

7066
[[flush-api-query-params]]
7167
==== {api-query-parms-title}

0 commit comments

Comments
 (0)