honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
OpenSearch/docs/reference/snapshot-restore/apis/snapshot-restore-apis.asciidoc

37 lines
1.2 KiB
Plaintext
Raw Normal View History

[DOCS] Add clean up snapshot repository API docs (#56519)
2020-05-12 09:54:49 -04:00
[[snapshot-restore-apis]]
== Snapshot and restore APIs
You can use the following APIs to set up snapshot repositories, manage snapshot
backups, and restore snapshots to a running cluster.
For more information, see <<snapshot-restore>>.
[discrete]
[[snapshot-restore-repo-apis]]
=== Snapshot repository management APIs
[DOCS] Add put snapshot repo API docs (#56827) (#56900)
2020-05-18 08:55:22 -04:00
* <<put-snapshot-repo-api,Put snapshot repository>>
[DOCS] Add verify snapshot repository API docs (#57253) (#57288)
2020-05-28 09:48:04 -04:00
* <<verify-snapshot-repo-api,Verify snapshot repository>>
[7.x] [DOCS] Adding delete snapshot API docs. (#58865) (#58871) * [DOCS] Adding delete snapshot API docs. * Adding TESTSETUP snippets and fixing original TEST. * Removing extraneous TESTSETUP. * Revising <snapshot> description. * Removing TEST. * Streamline delete API description. * Improve TESTSETUP for snippets.
2020-07-01 15:03:02 -04:00
* <<get-snapshot-repo-api,Get snapshot repository>>
* <<delete-snapshot-repo-api,Delete snapshot repository>>
* <<clean-up-snapshot-repo-api,Clean up snapshot repository>>
[DOCS] Add clean up snapshot repository API docs (#56519)
2020-05-12 09:54:49 -04:00
[DOCS] [7.x] Adding create index snapshot API docs (#58519) (#58692) * Adding create index snapshot API page. * Condense API description. * Remove parameter from query. * Add POST method and remove `-name` from the snapshot variable. * Expand description of `<snapshot>`. * Add data streams to introduction and expand the overall description. * Add support for data streams. * Add support for data streams. * Add data stream and reference for "point-in-time view". * Add data streams. * Change `my_backup` to `my_repository`. * Add description of boolean options for `wait_for_completion` parameter. * Change command --> response * Clarify `indices` parameter description * Update `ignore-unavailable` parameter description * Reword example description * Remove "index" from API name * Incorporating review comments from James R. * Adding a much better request + response * Clarify `include_global_state` description * Incorporating additional edits. * Changing my_backup to my_repository in example. * Update snippet test to avoid failures * Update TESTRESPONSE snippets * Remove errant space * Removing the parameter per reviewer comments
2020-06-29 16:13:53 -04:00
[discrete]
[[snapshot-management-apis]]
=== Snapshot management APIs
* <<create-snapshot-api,Create snapshot>>
[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.
2020-07-08 16:40:35 -04:00
* <<get-snapshot-api,Get snapshot>>
[DOCS] Adding get snapshot status API docs (#59355) (#59670) * Adding get snapshot status API docs. * Adding more fields and a link to the new page. * Adding missing spaces in TESTRESPONSES * Adding more parameters and making some edits. * Marking snapshot as optional * Marking repository as optional * Add data type for stats * Add data type for shard_stats * Incorporating review feedback. * Lots of review feedback incorporated. * Fixing tests to unbreak CI builds. * Changing indices to index.
2020-07-16 11:21:17 -04:00
* <<get-snapshot-status-api,Get snapshot status>>
[DOCS] Adding new page for restore snapshot API (#59937) (#60055) * Adding new page for restore snapshot API. * Improving test cases, lots of edits, and streamlining content. * Incorporating review suggestions and feedback. * Specify `index alias` vs `alias` * Change parameter order * Provide clarity around regular expression * Add link to SLM parameters * Split sentences in example * Adding link to master node page.
2020-07-22 12:08:55 -04:00
* <<restore-snapshot-api,Restore snapshot>>
[7.x] [DOCS] Adding delete snapshot API docs. (#58865) (#58871) * [DOCS] Adding delete snapshot API docs. * Adding TESTSETUP snippets and fixing original TEST. * Removing extraneous TESTSETUP. * Revising <snapshot> description. * Removing TEST. * Streamline delete API description. * Improve TESTSETUP for snippets.
2020-07-01 15:03:02 -04:00
* <<delete-snapshot-api,Delete snapshot>>
[DOCS] Add clean up snapshot repository API docs (#56519)
2020-05-12 09:54:49 -04:00
[DOCS] Add verify snapshot repository API docs (#57253) (#57288)
2020-05-28 09:48:04 -04:00
include::put-repo-api.asciidoc[]
[DOCS] [7.x] Adding create index snapshot API docs (#58519) (#58692) * Adding create index snapshot API page. * Condense API description. * Remove parameter from query. * Add POST method and remove `-name` from the snapshot variable. * Expand description of `<snapshot>`. * Add data streams to introduction and expand the overall description. * Add support for data streams. * Add support for data streams. * Add data stream and reference for "point-in-time view". * Add data streams. * Change `my_backup` to `my_repository`. * Add description of boolean options for `wait_for_completion` parameter. * Change command --> response * Clarify `indices` parameter description * Update `ignore-unavailable` parameter description * Reword example description * Remove "index" from API name * Incorporating review comments from James R. * Adding a much better request + response * Clarify `include_global_state` description * Incorporating additional edits. * Changing my_backup to my_repository in example. * Update snippet test to avoid failures * Update TESTRESPONSE snippets * Remove errant space * Removing the parameter per reviewer comments
2020-06-29 16:13:53 -04:00
include::verify-repo-api.asciidoc[]
[7.x] [DOCS] Adding delete snapshot API docs. (#58865) (#58871) * [DOCS] Adding delete snapshot API docs. * Adding TESTSETUP snippets and fixing original TEST. * Removing extraneous TESTSETUP. * Revising <snapshot> description. * Removing TEST. * Streamline delete API description. * Improve TESTSETUP for snippets.
2020-07-01 15:03:02 -04:00
include::get-repo-api.asciidoc[]
include::delete-repo-api.asciidoc[]
include::clean-up-repo-api.asciidoc[]
include::create-snapshot-api.asciidoc[]
[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.
2020-07-08 16:40:35 -04:00
include::get-snapshot-api.asciidoc[]
[DOCS] Adding get snapshot status API docs (#59355) (#59670) * Adding get snapshot status API docs. * Adding more fields and a link to the new page. * Adding missing spaces in TESTRESPONSES * Adding more parameters and making some edits. * Marking snapshot as optional * Marking repository as optional * Add data type for stats * Add data type for shard_stats * Incorporating review feedback. * Lots of review feedback incorporated. * Fixing tests to unbreak CI builds. * Changing indices to index.
2020-07-16 11:21:17 -04:00
include::get-snapshot-status-api.asciidoc[]
[DOCS] Adding new page for restore snapshot API (#59937) (#60055) * Adding new page for restore snapshot API. * Improving test cases, lots of edits, and streamlining content. * Incorporating review suggestions and feedback. * Specify `index alias` vs `alias` * Change parameter order * Provide clarity around regular expression * Add link to SLM parameters * Split sentences in example * Adding link to master node page.
2020-07-22 12:08:55 -04:00
include::restore-snapshot-api.asciidoc[]
[7.x] [DOCS] Adding delete snapshot API docs. (#58865) (#58871) * [DOCS] Adding delete snapshot API docs. * Adding TESTSETUP snippets and fixing original TEST. * Removing extraneous TESTSETUP. * Revising <snapshot> description. * Removing TEST. * Streamline delete API description. * Improve TESTSETUP for snippets.
2020-07-01 15:03:02 -04:00
include::delete-snapshot-api.asciidoc[]