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 Fleet API descriptions #184613

Merged
merged 2 commits into from
Jun 3, 2024
Merged

[HTTP/OAS] Add Fleet API descriptions #184613

merged 2 commits into from
Jun 3, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented May 31, 2024

Relates to #180056, #181992

This PR adds operation summaries for some Fleet APIs in the generated OpenAPI document. The goal is to replace https://github.com/elastic/kibana/blob/main/x-pack/plugins/fleet/common/openapi/bundled.json, which I believe is still manually maintained.

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/fleet | jq > test.json
    "/api/fleet/service_tokens": {
      "post": {
        "summary": "Create a service token",
        "requestBody": {

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting Team:Fleet Team label for Observability Data Collection Fleet team docs v8.15.0 labels May 31, 2024
@lcawl lcawl requested a review from kpollich May 31, 2024 20:16
@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 June 3, 2024 15:29
@lcawl lcawl requested a review from a team as a code owner June 3, 2024 15:29
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

Copy link
Member

@kpollich kpollich left a comment

Choose a reason for hiding this comment

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

Thanks @lcawl!

@kpollich
Copy link
Member

kpollich commented Jun 3, 2024

@elasticmachine merge upstream

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

✅ unchanged

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

@lcawl lcawl merged commit 74ae374 into elastic:main Jun 3, 2024
19 checks passed
@lcawl lcawl deleted the fleet-desc branch June 3, 2024 21:08
rohanxz pushed a commit to honeyn303/kibana that referenced this pull request Jun 4, 2024
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 release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants