diff --git a/oas_docs/output/kibana.serverless.yaml b/oas_docs/output/kibana.serverless.yaml index efd673df5fb5c..07103116dac66 100644 --- a/oas_docs/output/kibana.serverless.yaml +++ b/oas_docs/output/kibana.serverless.yaml @@ -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: @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/oas_docs/output/kibana.yaml b/oas_docs/output/kibana.yaml index c981a3add0de1..dee61be9cd3f7 100644 --- a/oas_docs/output/kibana.yaml +++ b/oas_docs/output/kibana.yaml @@ -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: @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 @@ -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 diff --git a/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.gen.ts b/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.gen.ts index 9f26cad0103ae..168c45e8f8e1a 100644 --- a/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.gen.ts +++ b/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.gen.ts @@ -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 diff --git a/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.schema.yaml b/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.schema.yaml index df674229565fb..3770babd4f742 100644 --- a/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.schema.yaml +++ b/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/bulk_actions/bulk_actions_route.schema.yaml @@ -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. @@ -1059,7 +1059,7 @@ components: type: string enum: - RULE_NOT_MODIFIED - + BulkGapsFillingSkipReason: type: string enum: @@ -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 @@ -1308,7 +1310,7 @@ components: required: - action - run - + BulkManualRuleFillGaps: allOf: - $ref: '#/components/schemas/BulkActionBase' @@ -1602,7 +1604,6 @@ components: - $ref: '#/components/schemas/BulkActionEditPayloadSchedule' - $ref: '#/components/schemas/BulkActionEditPayloadAlertSuppression' - BulkEditRules: allOf: - $ref: '#/components/schemas/BulkActionBase' diff --git a/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_route.gen.ts b/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_route.gen.ts index dc14314d0707c..50d81f03aca2b 100644 --- a/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_route.gen.ts +++ b/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_route.gen.ts @@ -39,7 +39,7 @@ export type ExportRulesRequestBody = z.infer; 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({ diff --git a/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_route.schema.yaml b/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_route.schema.yaml index 00ab724828599..f8f89f1bd3add 100644 --- a/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_route.schema.yaml +++ b/x-pack/solutions/security/plugins/security_solution/common/api/detection_engine/rule_management/export_rules/export_rules_route.schema.yaml @@ -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. diff --git a/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml b/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml index 885280f0a1eaa..2933ee06ede46 100644 --- a/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml +++ b/x-pack/solutions/security/plugins/security_solution/docs/openapi/ess/security_solution_detections_api_2023_10_31.bundled.schema.yaml @@ -2905,8 +2905,8 @@ paths: properties: objects: description: >- - 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. items: type: object properties: @@ -4816,9 +4816,11 @@ 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 @@ -4842,9 +4844,11 @@ 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 @@ -4881,9 +4885,11 @@ 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 @@ -4987,9 +4993,11 @@ 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 @@ -5018,9 +5026,11 @@ 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 @@ -5046,9 +5056,11 @@ 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 @@ -5091,9 +5103,11 @@ 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 @@ -5118,9 +5132,11 @@ 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 diff --git a/x-pack/solutions/security/plugins/security_solution/docs/openapi/serverless/security_solution_detections_api_2023_10_31.bundled.schema.yaml b/x-pack/solutions/security/plugins/security_solution/docs/openapi/serverless/security_solution_detections_api_2023_10_31.bundled.schema.yaml index 7ceb7e1547f45..285d8aef28458 100644 --- a/x-pack/solutions/security/plugins/security_solution/docs/openapi/serverless/security_solution_detections_api_2023_10_31.bundled.schema.yaml +++ b/x-pack/solutions/security/plugins/security_solution/docs/openapi/serverless/security_solution_detections_api_2023_10_31.bundled.schema.yaml @@ -2769,8 +2769,8 @@ paths: properties: objects: description: >- - 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. items: type: object properties: @@ -4146,9 +4146,11 @@ 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 @@ -4172,9 +4174,11 @@ 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 @@ -4211,9 +4215,11 @@ 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 @@ -4317,9 +4323,11 @@ 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 @@ -4348,9 +4356,11 @@ 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 @@ -4376,9 +4386,11 @@ 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 @@ -4421,9 +4433,11 @@ 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 @@ -4448,9 +4462,11 @@ 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