Skip to content

Commit 868ce3e

Browse files
jrodewigywangd
authored andcommitted
[DOCS] Update index template API docs for data stream aliases (elastic#75688)
With elastic#73867, you can use component and index templates to add data stream aliases.
1 parent ed1f47f commit 868ce3e

File tree

3 files changed

+11
-5
lines changed

3 files changed

+11
-5
lines changed

docs/reference/indices/create-index.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
7777
.Properties of `aliases` objects
7878
=======
7979
`<alias>`::
80-
(Required, object) The key is the alias name. Supports
80+
(Required, object) The key is the alias name. Index alias names support
8181
<<date-math-index-names,date math>>.
8282
+
8383
The object body contains options for the alias. Supports an empty object.

docs/reference/indices/put-component-template.asciidoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -132,8 +132,9 @@ This is the template to be applied, may optionally include a `mappings`,
132132
[%collapsible%open]
133133
====
134134
`aliases`::
135-
(Optional, object of objects) Aliases for the index. If an index template
136-
includes `data_stream`, this parameter is not supported.
135+
(Optional, object of objects) Aliases to add.
136+
+
137+
include::{es-repo-dir}/indices/put-index-template.asciidoc[tag=template-ds-alias]
137138
+
138139
include::{es-repo-dir}/indices/create-index.asciidoc[tag=aliases-props]
139140

docs/reference/indices/put-index-template.asciidoc

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,13 @@ Template to be applied. It may optionally include an `aliases`, `mappings`, or
137137
[%collapsible%open]
138138
====
139139
`aliases`::
140-
(Optional, object of objects) Aliases for the index. If the index template
141-
includes `data_stream`, this parameter is not supported.
140+
(Optional, object of objects) Aliases to add.
141+
+
142+
// tag::template-ds-alias[]
143+
If the index template includes a `data_stream` object, these are data stream
144+
aliases. Otherwise, these are index aliases. Data stream aliases ignore the
145+
`index_routing`, `routing`, and `search_routing` options.
146+
// end::template-ds-alias[]
142147
+
143148
include::{es-repo-dir}/indices/create-index.asciidoc[tag=aliases-props]
144149

0 commit comments

Comments
 (0)