Skip to content

Openapi: adding privileges #4434

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

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Openapi: adding privileges #4434

wants to merge 3 commits into from

Conversation

l-trotta
Copy link
Contributor

Closes #4303.

There was no desired output in the original issue, so I'm not sure if this is the format expected. Let me know and I'll change it!

@l-trotta l-trotta requested a review from lcawl May 30, 2025 16:07
@l-trotta l-trotta requested a review from a team as a code owner May 30, 2025 16:07
@l-trotta l-trotta added the skip-backport This pull request should not be backported label May 30, 2025
@l-trotta l-trotta marked this pull request as draft May 30, 2025 16:09
@l-trotta
Copy link
Contributor Author

validation failing because this adds a new field to the openapi output, will be fixed in case that's how we want to add the information

@lcawl
Copy link
Contributor

lcawl commented Jun 3, 2025

My two cents is that of the three options I mentioned in #4303 (comment), "an addendum tacked onto the beginning or end of the operation's "description" field" is likely the best current option since it aligns with what Kibana's doing. Otherwise I think if we went the extension route we'd need a more open-ended structure since the privileges in the Kibana and Cloud API docs would need different options than "cluster-privileges" and "index-privileges".

@georgewallace
Copy link

Coming into this one a little late but I do agree with @lcawl if we already have a team doing this a different way then we should follow suit to stay consistent. I do think long term keeping these as separate fields makes the most sense though. @lcawl is this what you are talking about?
Screenshot 2025-06-03 at 8 37 59 PM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
compiler skip-backport This pull request should not be backported
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Security privileges are missing from Elasticsearch API documentation
3 participants