-
Notifications
You must be signed in to change notification settings - Fork 501
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
Add 'Cleanup Snapshot' API Documentation #8373
Add 'Cleanup Snapshot' API Documentation #8373
Conversation
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. |
69c7137
to
65431f4
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]>
@Reiyadowns: Thank you for your contribution! I've added a few additional tweaks on top and will not pass this along to the our editor. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Reiyadowns @Naarcha-AWS Please see my comment/changes and let me know if you have any questions. Thanks!
|
||
| Field | Data type | Description | | ||
| :--- | :--- | :--- | | ||
| `deleted_bytes` | Integer | The amount of bytes freed after data deletion. | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
| `deleted_bytes` | Integer | The amount of bytes freed after data deletion. | | |
| `deleted_bytes` | Integer | The number of bytes freed after data deletion. | |
## Response body fields | ||
|
||
| Field | Data type | Description | | ||
| :--- | :--- | :--- | |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Below: Can we use something more precise than "freed"? Do we mean something like "The number of bytes made available by data deletion"?
Co-authored-by: Nathan Bower <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
* Add documentation for Clone Snapshot API Signed-off-by: Reiya Downs <[email protected]> * Add documentation for Cleanup Snapshot Repository API Signed-off-by: Reiya Downs <[email protected]> * Fixed minor errors, light editing Signed-off-by: Reiya Downs <[email protected]> * Remove erroneous clone-repository file Signed-off-by: Reiya Downs <[email protected]> * Update cleanup-snapshot-repository.md 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]> * Apply suggestions from code review 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 f4a5744) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
* Add documentation for Clone Snapshot API Signed-off-by: Reiya Downs <[email protected]> * Add documentation for Cleanup Snapshot Repository API Signed-off-by: Reiya Downs <[email protected]> * Fixed minor errors, light editing Signed-off-by: Reiya Downs <[email protected]> * Remove erroneous clone-repository file Signed-off-by: Reiya Downs <[email protected]> * Update cleanup-snapshot-repository.md 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]> * Apply suggestions from code review 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: [email protected] <[email protected]>
* Add documentation for Clone Snapshot API Signed-off-by: Reiya Downs <[email protected]> * Add documentation for Cleanup Snapshot Repository API Signed-off-by: Reiya Downs <[email protected]> * Fixed minor errors, light editing Signed-off-by: Reiya Downs <[email protected]> * Remove erroneous clone-repository file Signed-off-by: Reiya Downs <[email protected]> * Update cleanup-snapshot-repository.md 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]> * Apply suggestions from code review 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: [email protected] <[email protected]>
* Add documentation for Clone Snapshot API Signed-off-by: Reiya Downs <[email protected]> * Add documentation for Cleanup Snapshot Repository API Signed-off-by: Reiya Downs <[email protected]> * Fixed minor errors, light editing Signed-off-by: Reiya Downs <[email protected]> * Remove erroneous clone-repository file Signed-off-by: Reiya Downs <[email protected]> * Update cleanup-snapshot-repository.md 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]> * Apply suggestions from code review 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]>
Description
Adds documentation for the 'Cleanup Snapshot' API
Issues Resolved
Addresses half of issue #2111
(In combination with the branch 'add-clone-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.