Skip to content

[DOCS] Update index template API docs for data stream aliases #75688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 26, 2021
Merged

[DOCS] Update index template API docs for data stream aliases #75688

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ffeffa5
[DOCS] Update index template API docs for data stream aliases
jrodewig Jul 26, 2021
0f2eec3
Clarify date math support
jrodewig Jul 26, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/indices/create-index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
.Properties of `aliases` objects
=======
`<alias>`::
(Required, object) The key is the alias name. Supports
(Required, object) The key is the alias name. Index alias names support
<<date-math-index-names,date math>>.
+
The object body contains options for the alias. Supports an empty object.
Expand Down
5 changes: 3 additions & 2 deletions docs/reference/indices/put-component-template.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,8 +132,9 @@ This is the template to be applied, may optionally include a `mappings`,
[%collapsible%open]
====
`aliases`::
(Optional, object of objects) Aliases for the index. If an index template
includes `data_stream`, this parameter is not supported.
(Optional, object of objects) Aliases to add.
+
include::{es-repo-dir}/indices/put-index-template.asciidoc[tag=template-ds-alias]
+
include::{es-repo-dir}/indices/create-index.asciidoc[tag=aliases-props]

Expand Down
9 changes: 7 additions & 2 deletions docs/reference/indices/put-index-template.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,13 @@ Template to be applied. It may optionally include an `aliases`, `mappings`, or
[%collapsible%open]
====
`aliases`::
(Optional, object of objects) Aliases for the index. If the index template
includes `data_stream`, this parameter is not supported.
(Optional, object of objects) Aliases to add.
+
// tag::template-ds-alias[]
If the index template includes a `data_stream` object, these are data stream
aliases. Otherwise, these are index aliases. Data stream aliases ignore the
`index_routing`, `routing`, and `search_routing` options.
// end::template-ds-alias[]
+
include::{es-repo-dir}/indices/create-index.asciidoc[tag=aliases-props]

Expand Down