Skip to content

Commit d155590

Browse files
authored
[DOCS] Update <alias> parameter for cat aliases API (#73526) (#73528)
1 parent 1f1548d commit d155590

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

docs/reference/cat/alias.asciidoc

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@
77
Returns information about currently configured aliases to indices, including
88
filter and routing information.
99

10-
1110
[[cat-alias-api-request]]
1211
==== {api-request-title}
1312

14-
`GET /_cat/aliases/<alias>`
13+
`GET _cat/aliases/<alias>`
1514

16-
`GET /_cat/aliases`
15+
`GET _cat/aliases`
1716

1817
[[cat-alias-api-prereqs]]
1918
==== {api-prereq-title}
@@ -26,9 +25,9 @@ for any alias you retrieve.
2625
==== {api-path-parms-title}
2726

2827
`<alias>`::
29-
(Optional, string)
30-
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-alias]
31-
28+
(Optional, string) Comma-separated list of aliases to retrieve. Supports
29+
wildcards (`*`). To retrieve all aliases, omit this parameter or use `*` or
30+
`_all`.
3231

3332
[[cat-alias-api-query-params]]
3433
==== {api-query-parms-title}
@@ -47,14 +46,13 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
4746

4847
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=expand-wildcards]
4948

50-
5149
[[cat-alias-api-example]]
5250
==== {api-examples-title}
5351

5452
////
5553
Hidden setup for example:
56-
[source,console]
57-
--------------------------------------------------
54+
[source,console,id=cat-aliases-example]
55+
----
5856
PUT test1
5957
{
6058
"aliases": {
@@ -75,25 +73,25 @@ PUT test1
7573
}
7674
}
7775
}
78-
--------------------------------------------------
76+
----
7977
////
8078

8179
[source,console]
82-
--------------------------------------------------
83-
GET /_cat/aliases?v=true
84-
--------------------------------------------------
80+
----
81+
GET _cat/aliases?v=true
82+
----
8583
// TEST[continued]
8684

8785
The API returns the following response:
8886

8987
[source,txt]
90-
--------------------------------------------------
88+
----
9189
alias index filter routing.index routing.search is_write_index
9290
alias1 test1 - - - -
9391
alias2 test1 * - - -
9492
alias3 test1 - 1 1 -
9593
alias4 test1 - 2 1,2 -
96-
--------------------------------------------------
94+
----
9795
// TESTRESPONSE[s/[*]/[*]/ non_json]
9896

9997
This response shows that `alias2` has configured a filter, and specific routing

0 commit comments

Comments
 (0)