Skip to content

[Feedback]: Add back ES/KB privilege information to API docs #1353

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

Open
ecs-chrisg opened this issue May 3, 2025 · 0 comments
Open

[Feedback]: Add back ES/KB privilege information to API docs #1353

ecs-chrisg opened this issue May 3, 2025 · 0 comments
Labels
needs-team Issues pending triage by the Docs Team

Comments

@ecs-chrisg
Copy link

Was the documentation helpful?

No

What documentation page is affected

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete

Description

The old Elasticsearch and Kibana REST API documentation included a section for each API named "Prerequisites", which gave information about the Elasticsearch/Kibana security privilege which is required to execute the API. This information is valuable to understand what privilege is necessary to successfully call the API. For some APIs (e.g. new index, delete docs, etc.) its obvious what the relationship is between the API and the underlying privilege. But for other APIs (see example below), its not immediately obvious, so having the information within the API docs is extremely helpful and saves time.

For example, deleting a snapshot in a snapshot repository:

Image

  • New docs - Delete snapshots (no information about the privilege required to call the API)

Image

@github-actions github-actions bot added the needs-team Issues pending triage by the Docs Team label May 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-team Issues pending triage by the Docs Team
Projects
None yet
Development

No branches or pull requests

1 participant