Skip to content

[Security Solution] Improve bulk actions API reference docs #228712

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.

Sign up for GitHub

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

Merged
maximpn merged 5 commits into from
Jul 28, 2025
Merged

[Security Solution] Improve bulk actions API reference docs #228712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1f87fa1
improve bulk actions api reference docs
maximpn Jul 21, 2025
35f8dff
[CI] Auto-commit changed files from 'yarn openapi:bundle'
kibanamachine Jul 21, 2025
82398e2
[CI] Auto-commit changed files from 'make api-docs'
kibanamachine Jul 21, 2025
86ee68a
[CI] Auto-commit changed files from 'yarn openapi:generate'
kibanamachine Jul 21, 2025
d5638d4
Merge branch 'main' into explain-ids-in-api-reference-docs
maximpn Jul 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 25 additions & 9 deletions oas_docs/output/kibana.serverless.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9146,7 +9146,7 @@ paths:
type: object
properties:
objects:
description: Array of `rule_id` fields. Exports all rules when unspecified.
description: Array of objects with a rule's `rule_id` field. Do not use rule's `id` here. Exports all rules when unspecified.
items:
type: object
properties:
Expand Down Expand Up @@ -59776,7 +59776,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand All @@ -59800,7 +59802,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand Down Expand Up @@ -59837,7 +59841,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand Down Expand Up @@ -59935,7 +59941,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand Down Expand Up @@ -59964,7 +59972,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand All @@ -59990,7 +60000,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand Down Expand Up @@ -60031,7 +60043,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand All @@ -60056,7 +60070,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand Down
34 changes: 25 additions & 9 deletions oas_docs/output/kibana.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10821,7 +10821,7 @@ paths:
type: object
properties:
objects:
description: Array of `rule_id` fields. Exports all rules when unspecified.
description: Array of objects with a rule's `rule_id` field. Do not use rule's `id` here. Exports all rules when unspecified.
items:
type: object
properties:
Expand Down Expand Up @@ -69289,7 +69289,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand All @@ -69313,7 +69315,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand Down Expand Up @@ -69350,7 +69354,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand Down Expand Up @@ -69448,7 +69454,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand Down Expand Up @@ -69477,7 +69485,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand All @@ -69503,7 +69513,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand Down Expand Up @@ -69544,7 +69556,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand All @@ -69569,7 +69583,9 @@ components:
description: Gaps range start, valid only when query is provided
type: string
ids:
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
items:
type: string
minItems: 1
Expand Down
8 changes: 5 additions & 3 deletions ...lution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,9 +117,11 @@ export const BulkActionBase = z.object({
* Query to filter rules.
*/
query: z.string().optional(),
/**
* Array of rule IDs. Array of rule IDs to which a bulk action will be applied. Only valid when query property is undefined.
*/
/**
* Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.

*/
ids: z.array(z.string()).min(1).optional(),
/**
* Gaps range start, valid only when query is provided
Expand Down
11 changes: 6 additions & 5 deletions ...n/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -376,7 +376,7 @@ paths:
duration:
value: 1
unit: 'h'
missing_fields_strategy: 'suppress'
missing_fields_strategy: 'suppress'
example28:
summary: Edit - Set alert suppression to threshold rules (idempotent)
description: The following request set alert suppression to threshold rules with the specified IDs.
Expand Down Expand Up @@ -1059,7 +1059,7 @@ components:
type: string
enum:
- RULE_NOT_MODIFIED

BulkGapsFillingSkipReason:
type: string
enum:
Expand Down Expand Up @@ -1205,7 +1205,9 @@ components:
description: Query to filter rules.
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: |
Array of rule `id`s to which a bulk action will be applied. Do not use rule's `rule_id` here.
Only valid when query property is undefined.
minItems: 1
items:
type: string
Expand Down Expand Up @@ -1308,7 +1310,7 @@ components:
required:
- action
- run

BulkManualRuleFillGaps:
allOf:
- $ref: '#/components/schemas/BulkActionBase'
Expand Down Expand Up @@ -1602,7 +1604,6 @@ components:
- $ref: '#/components/schemas/BulkActionEditPayloadSchedule'
- $ref: '#/components/schemas/BulkActionEditPayloadAlertSuppression'


BulkEditRules:
allOf:
- $ref: '#/components/schemas/BulkActionBase'
Expand Down
2 changes: 1 addition & 1 deletion ...lution/common/api/detection_engine/rule_management/export_rules/export_rules_route.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export type ExportRulesRequestBody = z.infer<typeof ExportRulesRequestBody>;
export const ExportRulesRequestBody = z
.object({
/**
* Array of `rule_id` fields. Exports all rules when unspecified.
* Array of objects with a rule's `rule_id` field. Do not use rule's `id` here. Exports all rules when unspecified.
*/
objects: z.array(
z.object({
Expand Down
2 changes: 1 addition & 1 deletion ...n/common/api/detection_engine/rule_management/export_rules/export_rules_route.schema.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ paths:
properties:
rule_id:
$ref: '../../model/rule_schema/common_attributes.schema.yaml#/components/schemas/RuleSignatureId'
description: Array of `rule_id` fields. Exports all rules when unspecified.
description: Array of objects with a rule's `rule_id` field. Do not use rule's `id` here. Exports all rules when unspecified.
responses:
200:
description: Indicates a successful call.
Expand Down
Loading