Skip to content

[7.x] [DOCS] Adding get snapshot API docs#59238

Merged
lockewritesdocs merged 4 commits intoelastic:7.xfrom
lockewritesdocs:docs__get-snapshot-api-docs-7.x
Jul 8, 2020
Merged

[7.x] [DOCS] Adding get snapshot API docs#59238
lockewritesdocs merged 4 commits intoelastic:7.xfrom
lockewritesdocs:docs__get-snapshot-api-docs-7.x

Conversation

@lockewritesdocs
Copy link
Copy Markdown
Contributor

7.x backport for #59098

Relates to #56069

Adam Locke added 2 commits July 8, 2020 11:52
* 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 lockewritesdocs added >docs General docs changes :Distributed/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs Team:Distributed Meta label for distributed team. Team:Docs Meta label for docs team v7.9.0 labels Jul 8, 2020
@lockewritesdocs lockewritesdocs self-assigned this Jul 8, 2020
@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Copy Markdown
Collaborator

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

]
}
----
// TESTRESPONSE[s/"uuid": "vdRctLCxSketdKb54xw67g"/"uuid": $body.responses.0.snapshots.0.uuid/]
Copy link
Copy Markdown
Contributor

@jrodewig jrodewig Jul 8, 2020

Choose a reason for hiding this comment

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

Assuming this response format is correct, you'll need to change $body.responses.0.snapshots.0 to $body.snapshots.0 in these comments.

For example:

// TESTRESPONSE[s/"uuid": "vdRctLCxSketdKb54xw67g"/"uuid": $body.responses.0.snapshots.0.uuid/]

should become:

// TESTRESPONSE[s/"uuid": "vdRctLCxSketdKb54xw67g"/"uuid": $body.snapshots.0.uuid/]

There is no responses property for the CI to navigate through.

@lockewritesdocs lockewritesdocs changed the title Docs get snapshot api docs 7.x [7.x] [DOCS] Adding get snapshot api docs Jul 8, 2020
@lockewritesdocs lockewritesdocs merged commit 96a0668 into elastic:7.x Jul 8, 2020
@lockewritesdocs lockewritesdocs deleted the docs__get-snapshot-api-docs-7.x branch July 8, 2020 20:41
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 lockewritesdocs changed the title [7.x] [DOCS] Adding get snapshot api docs [7.x] [DOCS] Adding get snapshot API docs Jul 8, 2020
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

Labels

backport :Distributed/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes Team:Distributed Meta label for distributed team. Team:Docs Meta label for docs team v7.9.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants