Skip to content

Update get snapshot status API doc #111240

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Jul 25, 2024
Merged

Update get snapshot status API doc #111240

merged 3 commits into from
Jul 25, 2024

Conversation

pxsalehi
Copy link
Member

Make it clear that this API should be used only if the detailed shard info is needed and only on ongoing snapshots. Remove incorrectly mentioned STATE value.

@pxsalehi pxsalehi added >docs General docs changes :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs labels Jul 24, 2024
@github-actions GitHub Actions
Copy link
Contributor

Documentation preview:

@elasticsearchmachine elasticsearchmachine added Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team v8.16.0 labels Jul 24, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)

@pxsalehi pxsalehi requested a review from DaveCTurner July 24, 2024 15:13
DaveCTurner
DaveCTurner reviewed Jul 24, 2024
View reviewed changes
Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

Looks good but let's also adjust the corresponding comment to match:

elasticsearch/server/src/main/java/org/elasticsearch/action/admin/cluster/snapshots/status/TransportSnapshotsStatusAction.java

Lines 335 to 336 in cfbda24

// Translating both PARTIAL and SUCCESS to SUCCESS for now
// TODO: add the differentiation on the metadata level in the next major release

@pxsalehi
Copy link
Member Author

I've removed the TODO also. It doesn't seem like something that needs to be done. if that's not the case and you know a more concrete todo, let me know, I can add it back and add the v9 tag.

@pxsalehi pxsalehi requested a review from DaveCTurner July 25, 2024 07:49
DaveCTurner
DaveCTurner approved these changes Jul 25, 2024
View reviewed changes
Copy link
Contributor

@DaveCTurner DaveCTurner left a comment

Choose a reason for hiding this comment

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

LGTM but let's backport this to 8.15 and 8.14 too.

@pxsalehi pxsalehi added v8.15.1 v8.14.4 auto-merge-without-approval Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) auto-backport-and-merge labels Jul 25, 2024
@pxsalehi
Copy link
Member Author

@elasticmachine update branch

@elasticsearchmachine elasticsearchmachine merged commit 779f09e into elastic:main Jul 25, 2024
15 checks passed
@pxsalehi pxsalehi deleted the ps240724-update-get-snapshot-status-api-doc branch July 25, 2024 16:22
@pxsalehi pxsalehi mentioned this pull request Jul 25, 2024
Merged
pxsalehi added a commit to pxsalehi/elasticsearch that referenced this pull request Jul 25, 2024
@pxsalehi
Update get snapshot status API doc (elastic#111240)
614fd91 
Make it clear that this API should be used only if the detailed shard
info is needed and only on ongoing snapshots. Remove incorrectly
mentioned `STATE` value.
@pxsalehi pxsalehi mentioned this pull request Jul 25, 2024
Merged
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
✅ 8.15
✅ 8.14

pxsalehi added a commit to pxsalehi/elasticsearch that referenced this pull request Jul 25, 2024
@pxsalehi
Update get snapshot status API doc (elastic#111240)
d7bdbfa 
Make it clear that this API should be used only if the detailed shard
info is needed and only on ongoing snapshots. Remove incorrectly
mentioned `STATE` value.
elasticsearchmachine pushed a commit that referenced this pull request Jul 25, 2024
@pxsalehi
Update get snapshot status API doc (#111240) (#111296)
1fad334 
Make it clear that this API should be used only if the detailed shard
info is needed and only on ongoing snapshots. Remove incorrectly
mentioned `STATE` value.
elasticsearchmachine pushed a commit that referenced this pull request Jul 25, 2024
@pxsalehi
Update get snapshot status API doc (#111240) (#111295)
7d8fe4a 
Make it clear that this API should be used only if the detailed shard
info is needed and only on ongoing snapshots. Remove incorrectly
mentioned `STATE` value.
@lkts lkts mentioned this pull request Aug 13, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@DaveCTurner DaveCTurner DaveCTurner approved these changes

Assignees
No one assigned
Labels
auto-merge-without-approval Automatically merge pull request when CI checks pass (NB doesn't wait for reviews!) :Distributed Coordination/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. Team:Docs Meta label for docs team v8.14.4 v8.15.1 v8.16.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@pxsalehi @elasticsearchmachine @DaveCTurner @elasticmachine