-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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] Auto-bundle Detections API OpenAPI specs #186384
[Security Solution] Auto-bundle Detections API OpenAPI specs #186384
Conversation
Pinging @elastic/security-detections-response (Team:Detections and Resp) |
Pinging @elastic/security-solution (Team: SecuritySolution) |
Pinging @elastic/security-detection-rule-management (Team:Detection Rule Management) |
/api/detection_engine/rules/prepackaged/_status: | ||
get: | ||
operationId: GetPrebuiltRulesAndTimelinesStatus | ||
x-labels: [ess] | ||
x-codegen-enabled: true | ||
operationId: GetPrebuiltRulesAndTimelinesStatus |
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.
Is it because we're going to disable the legacy /api/detection_engine/rules/prepackaged
endpoints in Serverless?
I don't think we have a ticket or todo list item for that, or even ever discussed this.
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.
Yes. In general we discussed that deprecated API endpoints shouldn't be available in Serverless. It's not used by UI and is a good candidate to be excluded in Serverless.
..._solution/docs/openapi/ess/security_solution_detection_engine_2023_10_31.bundled.schema.yaml
Outdated
Show resolved
Hide resolved
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.
Approving in advance, thank you @maximpn, LGTM 👍
4e7bfed
to
aaa24e9
Compare
💛 Build succeeded, but was flaky
Failed CI StepsMetrics [docs]
History
To update your PR or re-run it, just comment with: cc @maximpn |
…188436) **Addresses**: #184428 **Relates to**: #186384 ## Summary This PR enables Detections API OpenAPI bundling in build pipeline. It also fixes wrong references which weren't caught by the OpenAPI Linter and code generator. For some reason #186384 didn't enable OpenAPI bundling by including `.buildkite/scripts/steps/openapi_bundling/security_solution_openapi_bundling.sh` into `.buildkite/scripts/steps/checks.sh`.
**Addresses**: #184428 ## Summary This PR adds scripts for automatic bundling of Lists API OpenAPI specs as a part of PR pipeline. Corresponding resulting bundles are automatically committed in the Lists common package `kbn-securitysolution-lists-common` in the `docs/openapi/ess/` and `docs/openapi/serverless` folders (similar to #186384).
**Addresses**: #184428 ## Summary This PR adds scripts for automatic bundling of Exceptions API OpenAPI specs as a part of PR pipeline. Corresponding resulting bundles are automatically committed in the Lists common package `kbn-securitysolution-exceptions-common` in the `docs/openapi/ess/` and `docs/openapi/serverless` folders (similar to #186384).
…188985) **Addresses**: #184428 ## Summary This PR adds scripts for automatic bundling of Entity Analytics API OpenAPI specs as a part of PR pipeline. Corresponding result bundles are automatically committed to the Security Solution plugin `x-pack/plugins/osquery` in the `docs/openapi/ess` and `docs/openapi/serverless` folders (similar to #186384).
**Addresses**: #184428 ## Summary This PR adds scripts for automatic bundling of AI Assistant API OpenAPI specs as a part of PR pipeline. Corresponding result bundles are automatically committed to the Assistant Common package `x-pack/packages/kbn-elastic-assistant-common` in the `docs/openapi/ess/` and `docs/openapi/serverless` folders (similar to #186384).
**Addresses**: #184428 ## Summary This PR adds scripts for automatic bundling of Osquery API OpenAPI specs as a part of PR pipeline. Corresponding result bundles are automatically committed to the Osquery plugin `x-pack/plugins/osquery` in the `docs/openapi/ess` and `docs/openapi/serverless` folders (similar to #186384).
**Addresses**: #184428 ## Summary This PR adds scripts for automatic bundling of Timeline API OpenAPI specs as a part of PR pipeline. Corresponding result bundles are automatically committed to the Security Solution plugin `x-pack/plugins/security_solution` in the `docs/openapi/ess/` and `docs/openapi/serverless` folders (similar to #186384). --------- Co-authored-by: Jan Monschke <[email protected]> Co-authored-by: kibanamachine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>
…#188853) **Addresses**: #184428 ## Summary This PR adds scripts for automatic bundling of Endpoint Management API OpenAPI specs as a part of PR pipeline. Corresponding result bundles are automatically committed to the Security Solution plugin `x-pack/plugins/security_solution` in the `docs/openapi/ess/` and `docs/openapi/serverless` folders (similar to #186384).
…#189665) **Addresses**: #184428 ## Summary This PR adds scripts for automatic bundling of Endpoint Exceptions API OpenAPI specs as a part of PR pipeline. Corresponding result bundles are automatically committed to the Endpoint Exceptions common package `kbn-securitysolution-endpoint-exceptions-common` in the `docs/openapi/ess/` and `docs/openapi/serverless` folders (similar to #186384).
Addresses: #184428
Summary
This PR adds scripts for automatic bundling Detections API OpenAPI spec as a part of PR pipeline. Corresponding result bundles are automatically committed to
x-pack/plugins/security_solution/docs/openapi/ess/
andx-pack/plugins/security_solution/docs/openapi/serverless
folders.