Skip to content

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

Open
@ecs-chrisg

Description

@ecs-chrisg

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Team:SearchIssues owned by the Search Docs Team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions