Skip to content
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

[DOCS] Adds empty snapshot_id description to revert snapshot API docs #66036

Merged
merged 5 commits into from
Dec 9, 2020

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Dec 8, 2020

Overview

This PR adds info to the Revert snapshot API docs about a special snapshot_id called empty.

Preview

Path parameters

@szabosteve szabosteve added :ml Machine learning >docs General docs changes v7.11.0 v8.0.0 labels Dec 8, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/ml-core (:ml)

@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Dec 8, 2020
@elasticmachine
Copy link
Collaborator

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

@szabosteve szabosteve marked this pull request as draft December 8, 2020 15:42
@szabosteve szabosteve marked this pull request as ready for review December 8, 2020 17:19
@szabosteve szabosteve changed the title [DOCS] Adds a note about empty snapshot_id to revert snapshot API docs [DOCS] Adds empty snapshot_id description to revert snapshot API docs Dec 9, 2020
@@ -38,8 +40,12 @@ You can multiple snapshots for a single job in a single API request
by using a comma-separated list of `<snapshot_id>` or a wildcard expression.
You can get all snapshots for all calendars by using `_all`,
by specifying `*` as the `<snapshot_id>`, or by omitting the `<snapshot_id>`.
You can also specify `empty` as the <snapshot_id>. Revert to `empty` results in
Copy link
Contributor

Choose a reason for hiding this comment

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

Text looks good but it should move from the get-snapshot docs to the revert-snapshot docs.

Copy link
Contributor

@dimitris-athanasiou dimitris-athanasiou left a comment

Choose a reason for hiding this comment

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

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes :ml Machine learning Team:Docs Meta label for docs team v7.11.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants