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

[Fleet] Add OpenAPI tags to help group Fleet API requests #152386

Merged
merged 3 commits into from
Mar 1, 2023

Conversation

kpollich
Copy link
Member

Summary

Ref elastic/observability-docs#2715

Adds relevant tags to all operations in order to help group them more effectively in the generated docs.

@kpollich kpollich added release_note:skip Skip the PR/issue when compiling release notes Team:Fleet Team label for Observability Data Collection Fleet team docs labels Feb 28, 2023
@kpollich kpollich self-assigned this Feb 28, 2023
@kpollich kpollich requested a review from a team as a code owner February 28, 2023 18:44
@elasticmachine
Copy link
Contributor

Pinging @elastic/fleet (Team:Fleet)

@kpollich
Copy link
Member Author

Looks like we should probably use Title case in our tag names, based on how they render in the final Swagger UI (and likely our own internal UI) - so I'll update these to render better as part of this PR

https://petstore.swagger.io/?url=https://raw.githubusercontent.com/elastic/kibana/01bf04e3e588241f70cd82ac5e773d9b7dcd2959/x-pack/plugins/fleet/common/openapi/bundled.yaml

@kpollich
Copy link
Member Author

@kpollich
Copy link
Member Author

@elasticmachine merge upstream

@kibana-ci
Copy link
Collaborator

💚 Build Succeeded

Metrics [docs]

Unknown metric groups

ESLint disabled line counts

id before after diff
securitySolution 428 430 +2

Total ESLint disabled count

id before after diff
securitySolution 506 508 +2

History

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

cc @kpollich

Copy link
Contributor

@juliaElastic juliaElastic left a comment

Choose a reason for hiding this comment

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

Changes look great! 🚀

Copy link
Contributor

@criamico criamico 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 for this change!

@kpollich kpollich merged commit a0392f8 into elastic:main Mar 1, 2023
@kpollich kpollich deleted the fleet/openapi-tags branch March 1, 2023 12:49
@kibanamachine kibanamachine added v8.8.0 backport:skip This commit does not require backporting labels Mar 1, 2023
bmorelli25 pushed a commit to bmorelli25/kibana that referenced this pull request Mar 10, 2023
…2386)

## Summary

Ref elastic/observability-docs#2715

Adds relevant `tags` to all operations in order to help group them more
effectively in the generated docs.

---------

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
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.8.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants