Skip to content

Revive documentation for experimental Searchable Snapshots APIs#71927

Merged
tlrx merged 15 commits intoelastic:masterfrom
tlrx:revive-searchable-snapshots-rest-apis-doc
Apr 20, 2021
Merged

Revive documentation for experimental Searchable Snapshots APIs#71927
tlrx merged 15 commits intoelastic:masterfrom
tlrx:revive-searchable-snapshots-rest-apis-doc

Conversation

@tlrx
Copy link
Copy Markdown
Member

@tlrx tlrx commented Apr 20, 2021

This pull request revives the documentation of the "Clear Cache" and "Shard Stats" APIs of Searchable Snapshots that was removed in #62217. This is a partial revert of the commit b545c55 with some light wording changes.

@tlrx tlrx added >docs General docs changes :Distributed/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs v8.0.0 v7.13.0 labels Apr 20, 2021
@tlrx tlrx requested review from jrodewig and ywelsch April 20, 2021 12:43
@elasticmachine elasticmachine added Team:Docs Meta label for docs team Team:Distributed Meta label for distributed team. labels Apr 20, 2021
@elasticmachine
Copy link
Copy Markdown
Collaborator

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

@elasticmachine
Copy link
Copy Markdown
Collaborator

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

Copy link
Copy Markdown
Contributor

@ywelsch ywelsch left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Copy Markdown
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.

Thanks @tlrx. I left a few questions and suggestions but nothing I'd consider blocking. Thanks for re-adding these.

Comment on lines +23 to +26
If the {es} {security-features} are enabled, you must have the
`manage` cluster privilege and the `manage` index privilege
for any included indices to use this API.
For more information, see <<security-privileges>>.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
If the {es} {security-features} are enabled, you must have the
`manage` cluster privilege and the `manage` index privilege
for any included indices to use this API.
For more information, see <<security-privileges>>.
If the {es} {security-features} are enabled, you must have the `manage`
<<privileges-list-cluster,cluster privilege>> to use this API. You must also
have the `manage` <<privileges-list-indices,index privileges>> for the target
data stream or index.

Are index aliases not supported?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Are index aliases not supported?

I think they are.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We should note that in the prereqs and <target> def then.

tlrx and others added 11 commits April 20, 2021 16:17
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
…snapshots.stats.json

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
tlrx and others added 2 commits April 20, 2021 16:53
Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
@tlrx
Copy link
Copy Markdown
Member Author

tlrx commented Apr 20, 2021

@elasticmachine run elasticsearch-ci/2 (Failed because of #71919)

@tlrx tlrx merged commit f50b357 into elastic:master Apr 20, 2021
@tlrx tlrx deleted the revive-searchable-snapshots-rest-apis-doc branch April 20, 2021 16:34
@tlrx
Copy link
Copy Markdown
Member Author

tlrx commented Apr 20, 2021

Thanks Yannick and James!

tlrx added a commit to tlrx/elasticsearch that referenced this pull request Apr 20, 2021
…tic#71927)

This commit revives the documentation of the "Clear Cache" and
"Shard Stats" APIs of Searchable Snapshots that was removed
in elastic#62217. This is a partial revert of the commit b545c55 with
some light wording changes.

Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com>
tlrx added a commit that referenced this pull request Apr 20, 2021
This commit revives the documentation of the "Clear Cache" and
"Shard Stats" APIs of Searchable Snapshots that was removed
in #62217. This is a partial revert of the commit b545c55 with
some light wording changes.

Co-authored-by: James Rodewig 40268737+jrodewig@users.noreply.github.com

Backport of #71927
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

:Distributed/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs >docs General docs changes Team:Distributed Meta label for distributed team. Team:Docs Meta label for docs team v7.13.0 v8.0.0-alpha1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants