Skip to content
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

Merged

Conversation

Reiyadowns
Copy link
Contributor

@Reiyadowns Reiyadowns commented Sep 24, 2024

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

  • By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and subject to the Developers Certificate of Origin.
    For more information on following Developer Certificate of Origin and signing off your commits, please check here.

Copy link

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 Reiyadowns changed the title Add "Cleanup Snapshot" API Documentation Add 'Cleanup Snapshot' API Documentation Sep 24, 2024
@Naarcha-AWS Naarcha-AWS added backport 2.17 Backport for version 2.17 4 - Doc review PR: Doc review in progress labels Sep 25, 2024
@Naarcha-AWS Naarcha-AWS added 5 - Editorial review PR: Editorial review in progress and removed 4 - Doc review PR: Doc review in progress labels Oct 3, 2024
@Naarcha-AWS
Copy link
Collaborator

@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.

Copy link
Collaborator

@natebower natebower left a 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. |
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
| `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 |
| :--- | :--- | :--- |
Copy link
Collaborator

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"?

_api-reference/snapshots/cleanup-snapshot-repository.md Outdated Show resolved Hide resolved
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Naarcha-AWS <[email protected]>
@Naarcha-AWS Naarcha-AWS merged commit f4a5744 into opensearch-project:main Oct 3, 2024
5 checks passed
opensearch-trigger-bot bot pushed a commit that referenced this pull request Oct 3, 2024
* 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>
@Reiyadowns Reiyadowns deleted the add-cleanup-snapshot-docs branch October 4, 2024 18:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
5 - Editorial review PR: Editorial review in progress backport 2.17 Backport for version 2.17
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants