Skip to content

[DOCS] Adding get snapshot status API docs #59355

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 12 commits into from
Jul 15, 2020
Merged

[DOCS] Adding get snapshot status API docs #59355

merged 12 commits into from
Jul 15, 2020

Conversation

@lockewritesdocs
Copy link
Contributor

@lockewritesdocs lockewritesdocs commented Jul 10, 2020 •
edited
Loading

@lockewritesdocs lockewritesdocs self-assigned this Jul 10, 2020
@lockewritesdocs
Copy link
Contributor Author

lockewritesdocs commented Jul 10, 2020

@jrodewig, the tests that I added are failing for both start_time_in_millis and uuid, though I can't figure out why. The build indicates that it expected one value for uuid but returned another. Shouldn't [s/s/"uuid"] substitute a value and say "don't anticipate this exact value, just match against what is in the response"?

jrodewig
jrodewig reviewed Jul 10, 2020
View reviewed changes
Copy link
Contributor

@jrodewig jrodewig left a comment •
edited
Loading

Choose a reason for hiding this comment

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

@lockewritesdocs. I left a few comments that should help fix the CI tests. Mostly minor errors that were preventing the substitutions.

@lockewritesdocs lockewritesdocs marked this pull request as ready for review July 13, 2020 19:35
@lockewritesdocs lockewritesdocs added :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 v7.8.1 v7.9.0 v8.0.0 labels Jul 13, 2020
@elasticmachine
Copy link
Collaborator

elasticmachine commented Jul 13, 2020

Pinging @elastic/es-docs (>docs)

@elasticmachine
Copy link
Collaborator

elasticmachine commented Jul 13, 2020

Pinging @elastic/es-distributed (:Distributed/Snapshot/Restore)

jrodewig
jrodewig approved these changes Jul 13, 2020
View reviewed changes
Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

Overall LGTM.

The only blocking suggestions are that the <repository> and <snapshot> params look to be optional.

Feel free to ignore my other comments as you see fit. Thanks!

Adam Locke and others added 5 commits July 13, 2020 16:58
original-brownbear
original-brownbear suggested changes Jul 14, 2020
View reviewed changes
Copy link
Contributor

@original-brownbear original-brownbear left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Thanks @lockewritesdocs looks good overall, just a few points on the details.

Also, could we add a disclaimer/warning to this API that makes it clear that this might be very expensive to execute if you run it over a large number of snapshots or over snapshots that contain a large number of shards? People should really not be using this API as part of e.g. orchestration logic unless absolutely necessary IMO.

@DaveCTurner DaveCTurner mentioned this pull request Jul 15, 2020
Closed
10 tasks
original-brownbear
original-brownbear approved these changes Jul 15, 2020
View reviewed changes
Copy link
Contributor

@original-brownbear original-brownbear left a comment

Choose a reason for hiding this comment

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

LGTM thanks for the extra iterations @lockewritesdocs !

@lockewritesdocs lockewritesdocs merged commit 556f19d into elastic:master Jul 15, 2020
@lockewritesdocs lockewritesdocs deleted the docs__get-snapshot-status-api-docs branch July 15, 2020 20:28
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Jul 15, 2020
[DOCS] Adding get snapshot status API docs (elastic#59355)
9f79bc9 
* Adding get snapshot status API docs.

* Adding more fields and a link to the new page.

* Adding missing spaces in TESTRESPONSES

* Adding more parameters and making some edits.

* Marking snapshot as optional

* Marking repository as optional

* Add data type for stats

* Add data type for shard_stats

* Incorporating review feedback.

* Lots of review feedback incorporated.

* Fixing tests to unbreak CI builds.

* Changing indices to index.
@lockewritesdocs lockewritesdocs mentioned this pull request Jul 15, 2020
Merged
lockewritesdocs pushed a commit that referenced this pull request Jul 16, 2020
[DOCS] Adding get snapshot status API docs (#59355) (#59670)
305b46c 
* Adding get snapshot status API docs.

* Adding more fields and a link to the new page.

* Adding missing spaces in TESTRESPONSES

* Adding more parameters and making some edits.

* Marking snapshot as optional

* Marking repository as optional

* Add data type for stats

* Add data type for shard_stats

* Incorporating review feedback.

* Lots of review feedback incorporated.

* Fixing tests to unbreak CI builds.

* Changing indices to index.
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Jul 16, 2020
[DOCS] Adding get snapshot status API docs (elastic#59355)
0cf1cab 
* Adding get snapshot status API docs.

* Adding more fields and a link to the new page.

* Adding missing spaces in TESTRESPONSES

* Adding more parameters and making some edits.

* Marking snapshot as optional

* Marking repository as optional

* Add data type for stats

* Add data type for shard_stats

* Incorporating review feedback.

* Lots of review feedback incorporated.

* Fixing tests to unbreak CI builds.

* Changing indices to index.
@lockewritesdocs lockewritesdocs mentioned this pull request Jul 16, 2020
Merged
lockewritesdocs pushed a commit to lockewritesdocs/elasticsearch that referenced this pull request Jul 16, 2020
[DOCS] Adding get snapshot status API docs (elastic#59355)
1fea518 
* Adding get snapshot status API docs.

* Adding more fields and a link to the new page.

* Adding missing spaces in TESTRESPONSES

* Adding more parameters and making some edits.

* Marking snapshot as optional

* Marking repository as optional

* Add data type for stats

* Add data type for shard_stats

* Incorporating review feedback.

* Lots of review feedback incorporated.

* Fixing tests to unbreak CI builds.

* Changing indices to index.
@lockewritesdocs lockewritesdocs mentioned this pull request Jul 16, 2020
Merged
lockewritesdocs pushed a commit that referenced this pull request Jul 16, 2020
[DOCS] Adding get snapshot status API docs (#59355) (#59711)
e81aeb9 
* Adding get snapshot status API docs.

* Adding more fields and a link to the new page.

* Adding missing spaces in TESTRESPONSES

* Adding more parameters and making some edits.

* Marking snapshot as optional

* Marking repository as optional

* Add data type for stats

* Add data type for shard_stats

* Incorporating review feedback.

* Lots of review feedback incorporated.

* Fixing tests to unbreak CI builds.

* Changing indices to index.
lockewritesdocs pushed a commit that referenced this pull request Jul 16, 2020
[DOCS] Adding get snapshot status API docs (#59355) (#59712)
4c91848 
* Adding get snapshot status API docs.

* Adding more fields and a link to the new page.

* Adding missing spaces in TESTRESPONSES

* Adding more parameters and making some edits.

* Marking snapshot as optional

* Marking repository as optional

* Add data type for stats

* Add data type for shard_stats

* Incorporating review feedback.

* Lots of review feedback incorporated.

* Fixing tests to unbreak CI builds.

* Changing indices to index.
@jrodewig jrodewig mentioned this pull request Dec 9, 2021
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

2 more reviewers

@original-brownbear original-brownbear original-brownbear approved these changes

@jrodewig jrodewig jrodewig approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@lockewritesdocs lockewritesdocs

Labels

: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 v7.8.1 v7.9.0 v8.0.0-alpha1

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@lockewritesdocs @elasticmachine @original-brownbear @jrodewig @jakelandis