Skip to content

Remove REST APIs documentation for some experimental Searchable Snapshot REST APIs#62217

Merged
tlrx merged 1 commit intoelastic:masterfrom
tlrx:remove-docs-rest-apis
Sep 10, 2020
Merged

Remove REST APIs documentation for some experimental Searchable Snapshot REST APIs#62217
tlrx merged 1 commit intoelastic:masterfrom
tlrx:remove-docs-rest-apis

Conversation

@tlrx
Copy link
Copy Markdown
Member

@tlrx tlrx commented Sep 10, 2020

This pull request removes the documentation for some specific Searchable Snapshot REST APIs:

  • clear cache
  • searchable snapshot stats
  • repository stats

These APIs are low-level and are useful to investigate the behavior of snapshot backed indices but we expect them to be removed in the future or to appear in a different form.

@tlrx tlrx added >docs General docs changes :Distributed/Snapshot/Restore Anything directly related to the `_snapshot/*` APIs v8.0.0 v7.10.0 labels Sep 10, 2020
@tlrx tlrx requested a review from ywelsch September 10, 2020 12:57
@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-docs (>docs)

@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label Sep 10, 2020
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.

Let's also remove the implementation of the repository stats APIs (RestRepositoryStatsAction and friends). These are superseded by the metering APIs.

@tlrx
Copy link
Copy Markdown
Member Author

tlrx commented Sep 10, 2020

Thanks Yannick

tlrx added a commit that referenced this pull request Sep 10, 2020
…PIs (#62217) (#62231)

This commit removes the documentation for some specific Searchable Snapshot REST APIs:
- clear cache
- searchable snapshot stats
- repository stats

These APIs are low-level and are useful to investigate the behavior of snapshot
backed indices but we expect them to be removed in the future or to appear in
a different form.
tlrx added a commit to tlrx/elasticsearch that referenced this pull request Apr 20, 2021
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>
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:Docs Meta label for docs team v7.10.0 v8.0.0-alpha1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants