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] Add delete snapshot repo API docs #57043

Merged
merged 4 commits into from
May 21, 2020
Merged

[DOCS] Add delete snapshot repo API docs #57043

merged 4 commits into from
May 21, 2020

Conversation

jrodewig
Copy link
Contributor

@jrodewig jrodewig commented May 21, 2020

Changes:

  • Adds API reference docs for the delete snapshot repo API.

  • Corrects an error in the delete snapshot repo API spec. Comma-separated repository names are not supported.

  • Relocates the existing delete snapshot repo API example docs.

Adds API reference docs for the delete snapshot repo API.

Also corrects an error in the delete snapshot repo API spec.
Comma-separated repository names are not supported.
@jrodewig jrodewig added >docs General docs changes :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs v8.0.0 v7.7.1 v7.8.1 v7.9.0 labels May 21, 2020
@jrodewig jrodewig requested a review from DaveCTurner May 21, 2020 14:08
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (:Distributed/Snapshot/Restore)

@elasticmachine elasticmachine added the Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. label May 21, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

The other docs of this API are on the "take a snapshot" page for, I think, historical reasons. Could you move them to the "register a repository" page? Looks like just above the "shared file system repository" heading would be a good spot.

<titleabbrev>Delete snapshot repository</titleabbrev>
++++

Deletes one or more <<snapshots-register-repository,snapshot repositories>>.
Copy link
Contributor

Choose a reason for hiding this comment

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

TIL we accept wildcards here :) But, trappily, not a comma-separated list.

@jrodewig
Copy link
Contributor Author

Thanks @DaveCTurner. I've relocated the other delete repo docs to "Register a snapshot." I also updated some of the wording across the docs to better clarify that the delete snapshot API doesn't delete snapshots.

@jrodewig jrodewig requested a review from DaveCTurner May 21, 2020 14:46
@jrodewig
Copy link
Contributor Author

@elasticmachine run elasticsearch-ci/bwc

@jrodewig
Copy link
Contributor Author

@elasticmachine update branch

Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

LGTM thanks @jrodewig

@jrodewig jrodewig merged commit eae4a1c into elastic:master May 21, 2020
@jrodewig jrodewig deleted the docs__delete-repo-api branch May 21, 2020 17:59
jrodewig added a commit that referenced this pull request May 21, 2020
Changes:

* Adds API reference docs for the delete snapshot repo API.

* Corrects an error in the delete snapshot repo API spec. Comma-separated
repository names are not supported.

* Relocates the existing delete snapshot repo API example docs.
jrodewig added a commit that referenced this pull request May 21, 2020
Changes:

* Adds API reference docs for the delete snapshot repo API.

* Corrects an error in the delete snapshot repo API spec. Comma-separated
repository names are not supported.

* Relocates the existing delete snapshot repo API example docs.
jrodewig added a commit that referenced this pull request May 21, 2020
Changes:

* Adds API reference docs for the delete snapshot repo API.

* Corrects an error in the delete snapshot repo API spec. Comma-separated
repository names are not supported.

* Relocates the existing delete snapshot repo API example docs.
@jrodewig
Copy link
Contributor Author

Backport commits

master eae4a1c
7.x b3426dd
7.8 0e73721
7.7 e68a2ec

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
:Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team v7.7.1 v7.8.1 v7.9.0 v8.0.0-alpha1
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants