Skip to content
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

API security prerequisites #713

Closed
lcawl opened this issue Sep 9, 2021 · 0 comments · Fixed by #717
Closed

API security prerequisites #713

lcawl opened this issue Sep 9, 2021 · 0 comments · Fixed by #717

Comments

@lcawl
Copy link
Contributor

lcawl commented Sep 9, 2021

🚀 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant