Skip to content

API security prerequisites  #713

Closed
@lcawl

Description

@lcawl

🚀 Feature Proposal

Optional list of security privileges (and any other prerequisites?) for an API.

Motivation

When security is enabled in Elasticsearch, a user must have specific security privileges for many of our APIs to succeed.

Example

We currently document this type of information in the API reference docs like this, for example: https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-create-index.html#indices-create-api-prereqs

However, I think we're open to other formats. Since other Elastic products use OpenAPI specs (e.g. Cloud APIs), it might be useful to consider aligning this with the "security" field in https://swagger.io/specification/#openapi-object

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions