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

[Security Solution] Use more specific bulk action operationIds #190040

Merged

Conversation

maximpn
Copy link
Contributor

@maximpn maximpn commented Aug 7, 2024

Addresses: #190035

Summary

This PR fixes operationId conflicts in Security Solution OpenAPI specs.

Details

API reference documentation platform (Bump.sh) expects unique operationIds to build proper navigation on the documentation page. It's expected each operationId throughout whole Kibana since Kibana API reference documentation will contain all available API endpoints.

@maximpn maximpn added release_note:skip Skip the PR/issue when compiling release notes docs Team:Detections and Resp Security Detection Response Team Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. Team:Detection Rule Management Security Detection Rule Management Team Team:Security Generative AI Security Generative AI v8.16.0 labels Aug 7, 2024
@maximpn maximpn self-assigned this Aug 7, 2024
@maximpn maximpn force-pushed the fix-security-solution-oas-operationid-conflicts branch 2 times, most recently from cd4964f to 7d490d8 Compare August 7, 2024 14:32
@maximpn maximpn force-pushed the fix-security-solution-oas-operationid-conflicts branch from 7d490d8 to aef16b4 Compare August 7, 2024 18:17
@maximpn maximpn requested review from xcrzx and spong August 7, 2024 21:33
@maximpn maximpn marked this pull request as ready for review August 7, 2024 21:34
@maximpn maximpn requested review from a team as code owners August 7, 2024 21:34
@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detections-response (Team:Detections and Resp)

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-solution (Team: SecuritySolution)

@elasticmachine
Copy link
Contributor

Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management)

Copy link
Contributor

@xcrzx xcrzx left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@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

cc @maximpn

Copy link
Member

@spong spong 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 the cleanup here @maximpn!

@maximpn maximpn merged commit 7f8b565 into elastic:main Aug 12, 2024
39 checks passed
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Aug 12, 2024
@maximpn maximpn deleted the fix-security-solution-oas-operationid-conflicts branch August 12, 2024 21:50
bryce-b pushed a commit to bryce-b/kibana that referenced this pull request Aug 13, 2024
…ic#190040)

**Addresses:** elastic#190035

## Summary

This PR fixes `operationId` conflicts in Security Solution OpenAPI specs.

## Details

API reference documentation platform (Bump.sh) expects unique `operationId`s to build proper navigation on the documentation page. It's expected each `operationId` throughout whole Kibana since Kibana API reference documentation will contain all available API endpoints.
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:Detection Rule Management Security Detection Rule Management Team Team:Detections and Resp Security Detection Response Team Team:Security Generative AI Security Generative AI Team: SecuritySolution Security Solutions Team working on SIEM, Endpoint, Timeline, Resolver, etc. v8.16.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants