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

[DOCS] Edit snapshot and restore summaries and descriptions #3314

Merged
merged 6 commits into from
Dec 17, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Dec 16, 2024

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
snapshot.cleanup_repository 🟢 3/3 3/3
snapshot.clone 🟢 5/5 5/5
snapshot.create_repository 🔴 24/29 29/29
snapshot.create 🟢 28/28 28/28
snapshot.delete_repository 🟢 10/10 10/10
snapshot.delete 🔴 21/23 23/23
snapshot.get_repository 🔴 19/19 7/19
snapshot.get 🟢 13/13 13/13
snapshot.repository_verify_integrity Missing test Missing test
snapshot.restore 🟢 5/5 5/5
snapshot.status 🟢 2/2 2/2
snapshot.verify_repository 🟢 2/2 2/2

You can validate these APIs yourself by using the make validate target.

@lcawl lcawl requested a review from a team December 16, 2024 20:34
Copy link
Contributor

@karenzone karenzone left a comment

Choose a reason for hiding this comment

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

Left some suggestions inline wrt moving the word "only" closer to the restriction it modifies. I know this was existing content, so you can decide. Otherwise, LGTM. 🚀

output/openapi/elasticsearch-openapi.json Outdated Show resolved Hide resolved
output/openapi/elasticsearch-openapi.json Outdated Show resolved Hide resolved
output/openapi/elasticsearch-openapi.json Outdated Show resolved Hide resolved
output/schema/schema.json Outdated Show resolved Hide resolved
specification/snapshot/restore/SnapshotRestoreRequest.ts Outdated Show resolved Hide resolved
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
snapshot.cleanup_repository 🟢 3/3 3/3
snapshot.clone 🟢 5/5 5/5
snapshot.create_repository 🔴 24/29 29/29
snapshot.create 🟢 28/28 28/28
snapshot.delete_repository 🟢 10/10 10/10
snapshot.delete 🔴 21/23 23/23
snapshot.get_repository 🔴 19/19 7/19
snapshot.get 🟢 13/13 13/13
snapshot.repository_verify_integrity Missing test Missing test
snapshot.restore 🟢 5/5 5/5
snapshot.status 🟢 2/2 2/2
snapshot.verify_repository 🟢 2/2 2/2

You can validate these APIs yourself by using the make validate target.

1 similar comment
Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
snapshot.cleanup_repository 🟢 3/3 3/3
snapshot.clone 🟢 5/5 5/5
snapshot.create_repository 🔴 24/29 29/29
snapshot.create 🟢 28/28 28/28
snapshot.delete_repository 🟢 10/10 10/10
snapshot.delete 🔴 21/23 23/23
snapshot.get_repository 🔴 19/19 7/19
snapshot.get 🟢 13/13 13/13
snapshot.repository_verify_integrity Missing test Missing test
snapshot.restore 🟢 5/5 5/5
snapshot.status 🟢 2/2 2/2
snapshot.verify_repository 🟢 2/2 2/2

You can validate these APIs yourself by using the make validate target.

Copy link
Contributor

Following you can find the validation results for the APIs you have changed.

API Status Request Response
snapshot.cleanup_repository 🟢 3/3 3/3
snapshot.clone 🟢 5/5 5/5
snapshot.create_repository 🔴 24/29 29/29
snapshot.create 🟢 28/28 28/28
snapshot.delete_repository 🟢 10/10 10/10
snapshot.delete 🔴 21/23 23/23
snapshot.get_repository 🔴 19/19 7/19
snapshot.get 🟢 13/13 13/13
snapshot.repository_verify_integrity Missing test Missing test
snapshot.restore 🟢 5/5 5/5
snapshot.status 🟢 2/2 2/2
snapshot.verify_repository 🟢 2/2 2/2

You can validate these APIs yourself by using the make validate target.

@lcawl
Copy link
Contributor Author

lcawl commented Dec 17, 2024

Left some suggestions inline wrt moving the word "only" closer to the restriction it modifies. I know this was existing content, so you can decide. Otherwise, LGTM. 🚀

Thanks for the edits! I've made added the suggested changes to the source files and regenerated the output files.

@lcawl lcawl merged commit 2d37c01 into main Dec 17, 2024
7 checks passed
@lcawl lcawl deleted the snapshot-summaries branch December 17, 2024 02:29
github-actions bot pushed a commit that referenced this pull request Dec 17, 2024
github-actions bot pushed a commit that referenced this pull request Dec 17, 2024
lcawl pushed a commit that referenced this pull request Dec 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants