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

[HTTP/OAS] Add descriptions for role management APIs #184265

Merged
merged 7 commits into from
May 30, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented May 24, 2024

Summary

Relates to #180056

This PR adds operation summaries for the role management APIs and user session management API in the generated OpenAPI document.

How to test

Per #181277:

  1. Start Elasticsearch (e.g. yarn es snapshot --license trial)
  2. Add server.oas.enabled: true to kibana.dev.yml
  3. Start Kibana (e.g. yarn start --no-base-path)
  4. curl -s -u elastic http://localhost:5601/api/oas\?pathStartsWith\=/api/security/role | jq > test1.json
  5. curl -s -u elastic http://localhost:5601/api/oas\?pathStartsWith\=/api/security/session | jq > test2.json
    The output will contain info like this:
  "paths": {
    "/api/security/role/{name}": {
      "get": {
        "summary": "Get a role",

@lcawl lcawl added Feature:Users/Roles/API Keys release_note:skip Skip the PR/issue when compiling release notes docs v8.15.0 labels May 24, 2024
@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl marked this pull request as ready for review May 24, 2024 22:55
@lcawl lcawl requested a review from a team as a code owner May 24, 2024 22:55
@azasypkin azasypkin self-requested a review May 29, 2024 12:58
@azasypkin
Copy link
Member

@elasticmachine merge upstream

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Copy link
Member

@azasypkin azasypkin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@lcawl lcawl merged commit dfbfe05 into elastic:main May 30, 2024
17 checks passed
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label May 30, 2024
@lcawl lcawl deleted the role-mgmt-descriptions branch May 30, 2024 14:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport:skip This commit does not require backporting docs Feature:Users/Roles/API Keys release_note:skip Skip the PR/issue when compiling release notes v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants