-
Notifications
You must be signed in to change notification settings - Fork 25.6k
[Docs] Update Query Roles API documentation #120740
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
[Docs] Update Query Roles API documentation #120740
Conversation
The query roles API now returns built-in roles as well. This PR clarifies notes this and adds an example on how the built-in roles can be filtered out.
Documentation preview: |
Pinging @elastic/es-docs (Team:Docs) |
Pinging @elastic/es-security (Team:Security) |
Hi! This is a drive-by comment to make sure folks are aware that these API docs will not be carried forward to V9, so if the changes in this PR are applicable to that version, please ensure they occur in the following location: That's how we'll be generating API documentation going forward (e.g. https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-query-role). NOTE that since the rest of the documentation will also be undergoing a big migration, just a reminder not to hard-code any links when you're adding content to the specifications. For example, if you want to link to https://www.elastic.co/guide/en/elasticsearch/reference/current/built-in-roles.html I'd recommend using If you want more info, please reach out on #docs! |
@lcawl Thanks for the heads up! I'll open a PR in https://github.com/elastic/elasticsearch-specification since this documentation change is also relevant for v9. |
@slobodanadamovic can you get this approved and merged by tomorrow? Otherwise, you'll need to wait until February 20 to work on this after the docs freeze. |
Thanks for the info! Does this freeze also apply for docs update in https://github.com/elastic/elasticsearch-specification? |
The query roles API does not retrieve roles that are defined in `roles.yml` files. | ||
You can optionally filter the results with a query. Also, the results can be paginated and sorted. | ||
|
||
NOTE: As of Elasticsearch version *8.18.0*, this API automatically returns <<built-in-roles,built-in>> roles as well. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nit: not sure if we want to mention an ES version here. Wouldn't current docs be >=8.18 already?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good point! I'll remove it.
I'm pretty sure it does not impact the spec, but @lcawl will keep me honest. (I shared the email link in Slack for full comms info) |
💚 Backport successful
|
The query role API now returns built-in roles as well. This PR notes this and adds an example on how the built-in roles can be filtered out.
The query role API now returns built-in roles as well.
This PR notes this and adds an example on how the built-in roles can be filtered out.