[8.18] [Security Solution] Improve bulk actions API reference docs (#228712)#229993
Merged
maximpn merged 8 commits intoelastic:8.18from Jul 31, 2025
Merged
[8.18] [Security Solution] Improve bulk actions API reference docs (#228712)#229993maximpn merged 8 commits intoelastic:8.18from
maximpn merged 8 commits intoelastic:8.18from
Conversation
…228712) ## Summary This PR improves description on rule bulk action `ids` to make it clear rule's saved object ID is used. (cherry picked from commit 642f6b3) # Conflicts: # oas_docs/output/kibana.serverless.yaml # oas_docs/output/kibana.yaml # x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.schema.yaml # x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml # x-pack/solutions/security/plugins/security_solution/docs/openapi/serverless/security_solution_detections_api_2023_10_31.bundled.schema.yaml
jkelas
reviewed
Jul 31, 2025
| - delete | ||
| type: string | ||
| ids: | ||
| <<<<<<< HEAD |
Contributor
Author
There was a problem hiding this comment.
In fact oas_docs/output/kibana.serverless.yaml file isn't used in stack versions so the content is irrelevant. I've fixed the conflicts for consistency.
jkelas
reviewed
Jul 31, 2025
| @@ -4210,8 +4214,9 @@ components: | |||
| type: string | |||
| ids: | |||
| description: >- | |||
Contributor
There was a problem hiding this comment.
In the original PR these places were changed, and here not. Please check.
Contributor
Author
There was a problem hiding this comment.
There are different formatting options. It looks like YAML writer lib either either a different configuration or version compared to the main branch.
jkelas
reviewed
Jul 31, 2025
| ids: | ||
| type: array | ||
| description: Array of rule IDs. Array of rule IDs to which a bulk action will be applied. Only valid when query property is undefined. | ||
| description: |
Contributor
There was a problem hiding this comment.
In the original PR there is an additional | character at the end of this line, please check
jkelas
approved these changes
Jul 31, 2025
Contributor
jkelas
left a comment
jkelas
left a comment
There was a problem hiding this comment.
I confirm the backport is done correctly. Approving.
Contributor
💚 Build Succeeded
Metrics [docs]
History
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
mainto8.18:Questions ?
Please refer to the Backport tool documentation