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] Snapshot/restore APIs are missing from the REST APIs docs #56069

Closed
10 tasks done
DaveCTurner opened this issue May 1, 2020 · 5 comments
Closed
10 tasks done

[DOCS] Snapshot/restore APIs are missing from the REST APIs docs #56069

DaveCTurner opened this issue May 1, 2020 · 5 comments
Assignees
Labels
>bug :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

Comments

@DaveCTurner
Copy link
Contributor

DaveCTurner commented May 1, 2020

A user on the forums observed that the snapshot APIs are documented under the "Snapshot/Restore" topic and not in the burgeoning "REST APIs" section of the reference manual. I suspect this isn't deliberate and we'll eventually add those docs, but I'm opening this issue to capture this observation in case it isn't tracked elsewhere.

Snapshots/restore APIs to document:

@DaveCTurner DaveCTurner added >bug >docs General docs changes :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs labels May 1, 2020
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

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

@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. labels May 1, 2020
original-brownbear added a commit to original-brownbear/elasticsearch that referenced this issue May 2, 2020
@jrodewig jrodewig reopened this May 4, 2020
@jrodewig
Copy link
Contributor

jrodewig commented May 4, 2020

I believe this was closed in error. Reopening.

@jrodewig jrodewig self-assigned this May 8, 2020
@jrodewig jrodewig changed the title Snapshot/restore APIs are missing from the REST APIs docs [DOCS] Snapshot/restore APIs are missing from the REST APIs docs May 15, 2020
@jrodewig jrodewig assigned lockewritesdocs and unassigned jrodewig May 27, 2020
@jrodewig
Copy link
Contributor

@lockewritesdocs I've left a checklist of APIs left to document in the description. Those with PRs listed to the right are already done or in flight. Thanks!

@lockewritesdocs
Copy link
Contributor

All snapshot and restore APIs are documented 🎉 Marking this issue as closed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>bug :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
Projects
None yet
Development

No branches or pull requests

4 participants