Skip to content

[DOCS] Reuse aliases object properties in API docs #73421

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.

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 3 commits into from
Jun 2, 2021
Merged

[DOCS] Reuse aliases object properties in API docs #73421

merged 3 commits into from
Jun 2, 2021

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented May 26, 2021

Changes:

  • Reuses the same aliases object properties in the following API docs:
    • Clone index API
    • Create index API
    • Put component template API
    • Put legacy index template API
    • Put index template API
    • Rollover index API
    • Shrink index API
    • Simulate template API
    • Split index API
  • Updates the aliases object properties for the simulate index API docs.

Closes #73044

Previews

https://elasticsearch_73421.docs-preview.app.elstc.co/diff

@jrodewig jrodewig marked this pull request as ready for review May 28, 2021 13:49
@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label May 28, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@jrodewig jrodewig requested a review from debadair May 28, 2021 13:49
@jrodewig jrodewig added the :Data Management/Indices APIs APIs to create and manage indices and templates label May 28, 2021
@elasticmachine elasticmachine added the Team:Data Management Meta label for data/management team label May 28, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-core-features (Team:Core/Features)

jrodewig added 2 commits June 1, 2021 10:44
Updates the docs for several APIs to use the same `aliases` object
properties. Also notes where `aliases` do not apply to data streams or
templates with data stream enabled.
@jrodewig jrodewig added v7.13.2 and removed v7.13.1 labels Jun 1, 2021
@jrodewig
Copy link
Contributor Author

jrodewig commented Jun 1, 2021

@elasticmachine run elasticsearch-ci/docs

Copy link
Contributor

@debadair debadair left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@jrodewig
Copy link
Contributor Author

jrodewig commented Jun 2, 2021

Thanks @debadair.

@jrodewig jrodewig merged commit f1e1661 into elastic:master Jun 2, 2021
@jrodewig jrodewig deleted the docs__update-template-alias-docs branch June 2, 2021 12:31
jrodewig added a commit that referenced this pull request Jun 2, 2021
Changes:
* Reuses the same `aliases` object properties in the following API docs:
  * Clone index API
  * Create index API
  * Put component template API
  * Put legacy index template API
  * Put index template API
  * Rollover index API
  * Shrink index API
  * Simulate template API
  * Split index API
* Updates the `aliases` object properties for the simulate index API docs.

Closes #73044
jrodewig added a commit that referenced this pull request Jun 2, 2021
Changes:
* Reuses the same `aliases` object properties in the following API docs:
  * Clone index API
  * Create index API
  * Put component template API
  * Put legacy index template API
  * Put index template API
  * Rollover index API
  * Shrink index API
  * Simulate template API
  * Split index API
* Updates the `aliases` object properties for the simulate index API docs.

Closes #73044
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Data Management/Indices APIs APIs to create and manage indices and templates >docs General docs changes Team:Data Management Meta label for data/management team Team:Docs Meta label for docs team v7.13.2 v7.14.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Update docs for data stream aliases
4 participants