Add 'Clone Snapshot' API Documentation #8371
Merged
Conversation
This file contains hidden or 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
Reiyadowns
requested review from
AMoo-Miki,
Naarcha-AWS,
dlvenable,
epugh,
kolchfa-aws,
natebower,
stephen-crawford and
vagimeli
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
Reiyadowns
force-pushed
the
add-clone-snapshot-docs
branch
from
7a80514 to
4cde4ca
Compare
Signed-off-by: Reiya Downs <[email protected]>
Signed-off-by: Reiya Downs <[email protected]>
Signed-off-by: Reiya Downs <[email protected]>
Signed-off-by: Reiya Downs <[email protected]>
…ns/opensearch-documentation-website into add-clone-snapshot-docs Branch has been updated remotely. Need to update locally to keep branches in sync. Signed-off-by: Reiya Downs <[email protected]>
Naarcha-AWS
added
backport 2.17
|
Hi all, just checking in on this PR. It’s been open for a while, and I wanted to see if there’s anything I can do? |
|
@Reiyadowns: We recently automated some of our API documentation based on OpenSearch API specification. I'm going to adjust this PR to add those automation markers then get this merged. |
|
@Naarcha-AWS Awesome, thanks for the update! |
Signed-off-by: Naarcha-AWS <[email protected]>
Will loop back around once all missing request descriptions have been added to core. Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
reviewed
Mar 28, 2025
Naarcha-AWS
reviewed
Mar 28, 2025
Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
approved these changes
Mar 28, 2025
Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
reviewed
Mar 28, 2025
Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
reviewed
Mar 28, 2025
Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
added
Editorial review
natebower
requested changes
Mar 28, 2025
There was a problem hiding this comment.
@Naarcha-AWS Please see my comments and changes and tag me for approval when addressed. Thanks!
|
|
||
| ## Example response | ||
|
|
||
| The following example shows an API response: |
There was a problem hiding this comment.
Can we be a bit more descriptive here about what the response shows?
Naarcha-AWS
reviewed
Mar 28, 2025
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Naarcha-AWS
approved these changes
Mar 28, 2025
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Mar 28, 2025
* Add documentation for Clone Snapshot API Signed-off-by: Reiya Downs <[email protected]> * Light edits Signed-off-by: Reiya Downs <[email protected]> * Fixed title Signed-off-by: Reiya Downs <[email protected]> * Remove unnecessary clone-repository file Signed-off-by: Reiya Downs <[email protected]> * Update page with automation markers Signed-off-by: Naarcha-AWS <[email protected]> * Remove response body. Will loop back around once all missing request descriptions have been added to core. Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Update clone-snapshot.md Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Reiya Downs <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]> (cherry picked from commit a241c00) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
3 tasks
epugh
pushed a commit
to o19s/documentation-website
that referenced
this pull request
Jul 2, 2025
* Add documentation for Clone Snapshot API Signed-off-by: Reiya Downs <[email protected]> * Light edits Signed-off-by: Reiya Downs <[email protected]> * Fixed title Signed-off-by: Reiya Downs <[email protected]> * Remove unnecessary clone-repository file Signed-off-by: Reiya Downs <[email protected]> * Update page with automation markers Signed-off-by: Naarcha-AWS <[email protected]> * Remove response body. Will loop back around once all missing request descriptions have been added to core. Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Update clone-snapshot.md Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Signed-off-by: Naarcha-AWS <[email protected]> * Apply suggestions from code review Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> --------- Signed-off-by: Reiya Downs <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Eric Pugh <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Description
Adds documentation for the 'Clone Snapshot' API
Issues Resolved
Addresses half of issue #2111
(In combination with the branch 'add-cleanup-snapshot-docs', the issue is fully addressed and can be closed)
Version
Applies to all versions.
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.