Skip to content

[9.0] [Security Solution] Improve bulk actions API reference docs (#228712)#229992

Merged
maximpn merged 8 commits intoelastic:9.0from
maximpn:backport/9.0/pr-228712
Jul 31, 2025
Merged

[9.0] [Security Solution] Improve bulk actions API reference docs (#228712)#229992
maximpn merged 8 commits intoelastic:9.0from
maximpn:backport/9.0/pr-228712

Conversation

@maximpn
Copy link
Contributor

@maximpn maximpn commented Jul 30, 2025

Backport

This will backport the following commits from main to 9.0:

Questions ?

Please refer to the Backport tool documentation

…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
@maximpn maximpn requested a review from kibanamachine as a code owner July 30, 2025 17:34
@maximpn maximpn added the backport This PR is a backport of another PR label Jul 30, 2025
@maximpn maximpn enabled auto-merge (squash) July 30, 2025 17:34
@@ -2841,8 +2841,8 @@ paths:
properties:
objects:
description: >-
Copy link
Contributor

Choose a reason for hiding this comment

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

In the original PR these lines were changed, but not in the backport. Why?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This file is auto-generated. It could be due to yaml writer configuration and different writer versions.

type: string
required:
- action
<<<<<<< HEAD
Copy link
Contributor

Choose a reason for hiding this comment

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

Unresolved conflict

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:
Copy link
Contributor

Choose a reason for hiding this comment

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

In the original PR there is a | character at the end of this line, please check.

Copy link
Contributor

@jkelas jkelas left a comment

Choose a reason for hiding this comment

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

I confirm the backport is done correctly. Approving.

@maximpn maximpn merged commit 5d4cc3f into elastic:9.0 Jul 31, 2025
9 checks passed
@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

History

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport This PR is a backport of another PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants