[DOCS] Adding get snapshot API docs #59098
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lockewritesdocs
added
>docs
|
Pinging @elastic/es-docs (>docs) |
|
Pinging @elastic/es-distributed (:Distributed/Snapshot/Restore) |
|
@original-brownbear, I see that multiple snapshot support is added in 8.0, so I will revise the |
10 tasks
Correct thanks. BTW, seems there's some doc tests issue here can you take a look? |
jrodewig
previously requested changes
Jul 7, 2020
There was a problem hiding this comment.
Aside from some issues with the response format, this look good overall.
I'd consider adding documentation for the response parameters as those are
the main point of a get API. I left some links and suggestions on fixing the CI tests.
The other feedback consist of nits you can take/ignore as you see fit.
Co-authored-by: James Rodewig <[email protected]>
Co-authored-by: James Rodewig <[email protected]>
Co-authored-by: James Rodewig <[email protected]>
Co-authored-by: James Rodewig <[email protected]>
lockewritesdocs
commented
Jul 7, 2020
| @@ -76,6 +83,78 @@ If `true`, returns all available information about a snapshot. Defaults to `true | |||
| + | |||
| If `false`, omits additional information about the snapshot, such as version information, start and end times, and the number of snapshotted shards. | |||
|
|
|||
| [role="child-attributes"] | |||
There was a problem hiding this comment.
@original-brownbear, can you please review the response body parameters that I added in lines 87-157?
jrodewig
reviewed
Jul 7, 2020
Co-authored-by: James Rodewig <[email protected]>
Co-authored-by: James Rodewig <[email protected]>
jrodewig
approved these changes
Jul 8, 2020
lockewritesdocs
pushed a commit
to lockewritesdocs/elasticsearch
that referenced
this pull request
Jul 8, 2020
* Adding page for get snapshot API. * Adding values for state and cleaning up some other formatting. * Adding missing forward slash to GET request. * Updating values for start_time and end_time in TESTRESPONSE. * Swap "return" for "retrieve" * Swap "return" for "retrieve" 2 * Change .snapshot to .response * Adding response parameters and incorporating edits from review. * Update response example to include repository info * Change dash to underscore * Add data type for snapshot in response * Incorporating review comments and adding missing response definitions. * Minor rewording in description.
lockewritesdocs
pushed a commit
that referenced
this pull request
Jul 8, 2020
* [DOCS] Adding get snapshot API docs (#59098) * Adding page for get snapshot API. * Adding values for state and cleaning up some other formatting. * Adding missing forward slash to GET request. * Updating values for start_time and end_time in TESTRESPONSE. * Swap "return" for "retrieve" * Swap "return" for "retrieve" 2 * Change .snapshot to .response * Adding response parameters and incorporating edits from review. * Update response example to include repository info * Change dash to underscore * Add data type for snapshot in response * Incorporating review comments and adding missing response definitions. * Minor rewording in description. * Removing multi-snapshot support for 7.x. * Changing end_time value from build error. * Removing .response from snippet testing.
lockewritesdocs
pushed a commit
to lockewritesdocs/elasticsearch
that referenced
this pull request
Jul 8, 2020
* [DOCS] Adding get snapshot API docs (elastic#59098) * Adding page for get snapshot API. * Adding values for state and cleaning up some other formatting. * Adding missing forward slash to GET request. * Updating values for start_time and end_time in TESTRESPONSE. * Swap "return" for "retrieve" * Swap "return" for "retrieve" 2 * Change .snapshot to .response * Adding response parameters and incorporating edits from review. * Update response example to include repository info * Change dash to underscore * Add data type for snapshot in response * Incorporating review comments and adding missing response definitions. * Minor rewording in description. * Removing multi-snapshot support for 7.x. * Changing end_time value from build error. * Removing .response from snippet testing.
lockewritesdocs
pushed a commit
that referenced
this pull request
Jul 8, 2020
* [7.x] [DOCS] Adding get snapshot api docs (#59238) * [DOCS] Adding get snapshot API docs (#59098) * Adding page for get snapshot API. * Adding values for state and cleaning up some other formatting. * Adding missing forward slash to GET request. * Updating values for start_time and end_time in TESTRESPONSE. * Swap "return" for "retrieve" * Swap "return" for "retrieve" 2 * Change .snapshot to .response * Adding response parameters and incorporating edits from review. * Update response example to include repository info * Change dash to underscore * Add data type for snapshot in response * Incorporating review comments and adding missing response definitions. * Minor rewording in description. * Removing multi-snapshot support for 7.x. * Changing end_time value from build error. * Removing .response from snippet testing. * Removing data streams for 7.8.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a new page for the Get index snapshot API.
Relates to #56069