[8.x] [Rules migration] Add rules migrations update route (#11209) (#200815)

x-pack/plugins/security_solution/common/api/quickstart_client.gen.ts

@@ -378,6 +378,8 @@ import type {
   StartRuleMigrationResponse,
   StopRuleMigrationRequestParamsInput,
   StopRuleMigrationResponse,
+  UpdateRuleMigrationRequestBodyInput,
+  UpdateRuleMigrationResponse,
   UpsertRuleMigrationResourcesRequestParamsInput,
   UpsertRuleMigrationResourcesRequestBodyInput,
   UpsertRuleMigrationResourcesResponse,
@@ -2086,6 +2088,22 @@ detection engine rules.
       })
       .catch(catchAxiosErrorFormatAndThrow);
   }
+  /**
+   * Updates rules migrations attributes
+   */
+  async updateRuleMigration(props: UpdateRuleMigrationProps) {
+    this.log.info(`${new Date().toISOString()} Calling API UpdateRuleMigration`);
+    return this.kbnClient
+      .request<UpdateRuleMigrationResponse>({
+        path: '/internal/siem_migrations/rules',
+        headers: {
+          [ELASTIC_HTTP_VERSION_HEADER]: '1',
+        },
+        method: 'PUT',
+        body: props.body,
+      })
+      .catch(catchAxiosErrorFormatAndThrow);
+  }
   async uploadAssetCriticalityRecords(props: UploadAssetCriticalityRecordsProps) {
     this.log.info(`${new Date().toISOString()} Calling API UploadAssetCriticalityRecords`);
     return this.kbnClient
@@ -2394,6 +2412,9 @@ export interface TriggerRiskScoreCalculationProps {
 export interface UpdateRuleProps {
   body: UpdateRuleRequestBodyInput;
 }
+export interface UpdateRuleMigrationProps {
+  body: UpdateRuleMigrationRequestBodyInput;
+}
 export interface UploadAssetCriticalityRecordsProps {
   attachment: FormData;
 }

x-pack/plugins/security_solution/common/siem_migrations/model/api/rules/rule_migration.gen.ts

@@ -19,14 +19,17 @@ import { ArrayFromString } from '@kbn/zod-helpers';
 
 import {
   OriginalRule,
+  ElasticRulePartial,
+  RuleMigrationTranslationResult,
+  RuleMigrationComments,
   RuleMigrationAllTaskStats,
   RuleMigration,
   RuleMigrationTaskStats,
   RuleMigrationResourceData,
   RuleMigrationResourceType,
   RuleMigrationResource,
 } from '../../rule_migration.gen';
-import { ConnectorId, LangSmithOptions } from '../common.gen';
+import { NonEmptyString, ConnectorId, LangSmithOptions } from '../../common.gen';
 
 export type CreateRuleMigrationRequestBody = z.infer<typeof CreateRuleMigrationRequestBody>;
 export const CreateRuleMigrationRequestBody = z.array(OriginalRule);
@@ -37,15 +40,15 @@ export const CreateRuleMigrationResponse = z.object({
   /**
    * The migration id created.
    */
-  migration_id: z.string(),
+  migration_id: NonEmptyString,
 });
 
 export type GetAllStatsRuleMigrationResponse = z.infer<typeof GetAllStatsRuleMigrationResponse>;
 export const GetAllStatsRuleMigrationResponse = RuleMigrationAllTaskStats;
 
 export type GetRuleMigrationRequestParams = z.infer<typeof GetRuleMigrationRequestParams>;
 export const GetRuleMigrationRequestParams = z.object({
-  migration_id: z.string(),
+  migration_id: NonEmptyString,
 });
 export type GetRuleMigrationRequestParamsInput = z.input<typeof GetRuleMigrationRequestParams>;
 
@@ -66,7 +69,7 @@ export type GetRuleMigrationResourcesRequestParams = z.infer<
   typeof GetRuleMigrationResourcesRequestParams
 >;
 export const GetRuleMigrationResourcesRequestParams = z.object({
-  migration_id: z.string(),
+  migration_id: NonEmptyString,
 });
 export type GetRuleMigrationResourcesRequestParamsInput = z.input<
   typeof GetRuleMigrationResourcesRequestParams
@@ -77,7 +80,7 @@ export const GetRuleMigrationResourcesResponse = z.array(RuleMigrationResource);
 
 export type GetRuleMigrationStatsRequestParams = z.infer<typeof GetRuleMigrationStatsRequestParams>;
 export const GetRuleMigrationStatsRequestParams = z.object({
-  migration_id: z.string(),
+  migration_id: NonEmptyString,
 });
 export type GetRuleMigrationStatsRequestParamsInput = z.input<
   typeof GetRuleMigrationStatsRequestParams
@@ -88,7 +91,7 @@ export const GetRuleMigrationStatsResponse = RuleMigrationTaskStats;
 
 export type StartRuleMigrationRequestParams = z.infer<typeof StartRuleMigrationRequestParams>;
 export const StartRuleMigrationRequestParams = z.object({
-  migration_id: z.string(),
+  migration_id: NonEmptyString,
 });
 export type StartRuleMigrationRequestParamsInput = z.input<typeof StartRuleMigrationRequestParams>;
 
@@ -109,7 +112,7 @@ export const StartRuleMigrationResponse = z.object({
 
 export type StopRuleMigrationRequestParams = z.infer<typeof StopRuleMigrationRequestParams>;
 export const StopRuleMigrationRequestParams = z.object({
-  migration_id: z.string(),
+  migration_id: NonEmptyString,
 });
 export type StopRuleMigrationRequestParamsInput = z.input<typeof StopRuleMigrationRequestParams>;
 
@@ -121,11 +124,42 @@ export const StopRuleMigrationResponse = z.object({
   stopped: z.boolean(),
 });
 
+export type UpdateRuleMigrationRequestBody = z.infer<typeof UpdateRuleMigrationRequestBody>;
+export const UpdateRuleMigrationRequestBody = z.array(
+  z.object({
+    /**
+     * The rule migration id
+     */
+    id: NonEmptyString,
+    /**
+     * The migrated elastic rule attributes to update.
+     */
+    elastic_rule: ElasticRulePartial.optional(),
+    /**
+     * The rule translation result.
+     */
+    translation_result: RuleMigrationTranslationResult.optional(),
+    /**
+     * The comments for the migration including a summary from the LLM in markdown.
+     */
+    comments: RuleMigrationComments.optional(),
+  })
+);
+export type UpdateRuleMigrationRequestBodyInput = z.input<typeof UpdateRuleMigrationRequestBody>;
+
+export type UpdateRuleMigrationResponse = z.infer<typeof UpdateRuleMigrationResponse>;
+export const UpdateRuleMigrationResponse = z.object({
+  /**
+   * Indicates rules migrations have been updated.
+   */
+  updated: z.boolean(),
+});
+
 export type UpsertRuleMigrationResourcesRequestParams = z.infer<
   typeof UpsertRuleMigrationResourcesRequestParams
 >;
 export const UpsertRuleMigrationResourcesRequestParams = z.object({
-  migration_id: z.string(),
+  migration_id: NonEmptyString,
 });
 export type UpsertRuleMigrationResourcesRequestParamsInput = z.input<
   typeof UpsertRuleMigrationResourcesRequestParams
@@ -134,7 +168,16 @@ export type UpsertRuleMigrationResourcesRequestParamsInput = z.input<
 export type UpsertRuleMigrationResourcesRequestBody = z.infer<
   typeof UpsertRuleMigrationResourcesRequestBody
 >;
-export const UpsertRuleMigrationResourcesRequestBody = z.array(RuleMigrationResourceData);
+export const UpsertRuleMigrationResourcesRequestBody = z.array(
+  RuleMigrationResourceData.merge(
+    z.object({
+      /**
+       * The rule resource migration id
+       */
+      id: NonEmptyString,
+    })
+  )
+);
 export type UpsertRuleMigrationResourcesRequestBodyInput = z.input<
   typeof UpsertRuleMigrationResourcesRequestBody
 >;

x-pack/plugins/security_solution/common/siem_migrations/model/api/rules/rule_migration.schema.yaml

@@ -3,7 +3,6 @@ info:
   title: SIEM Rules Migration API
   version: '1'
 paths:
-
   # Rule migrations APIs
 
   /internal/siem_migrations/rules:
@@ -33,8 +32,52 @@ paths:
                   - migration_id
                 properties:
                   migration_id:
-                    type: string
                     description: The migration id created.
+                    $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
+
+    put:
+      summary: Updates rules migrations
+      operationId: UpdateRuleMigration
+      x-codegen-enabled: true
+      description: Updates rules migrations attributes
+      tags:
+        - SIEM Rule Migrations
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                type: object
+                required:
+                  - id
+                properties:
+                  id:
+                    description: The rule migration id
+                    $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
+                  elastic_rule:
+                    description: The migrated elastic rule attributes to update.
+                    $ref: '../../rule_migration.schema.yaml#/components/schemas/ElasticRulePartial'
+                  translation_result:
+                    description: The rule translation result.
+                    $ref: '../../rule_migration.schema.yaml#/components/schemas/RuleMigrationTranslationResult'
+                  comments:
+                    description: The comments for the migration including a summary from the LLM in markdown.
+                    $ref: '../../rule_migration.schema.yaml#/components/schemas/RuleMigrationComments'
+      responses:
+        200:
+          description: Indicates rules migrations have been updated correctly.
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - updated
+                properties:
+                  updated:
+                    type: boolean
+                    description: Indicates rules migrations have been updated.
 
   /internal/siem_migrations/rules/stats:
     get:
@@ -67,8 +110,8 @@ paths:
           in: path
           required: true
           schema:
-            type: string
             description: The migration id to start
+            $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
       responses:
         200:
           description: Indicates rule migration have been retrieved correctly.
@@ -94,8 +137,8 @@ paths:
           in: path
           required: true
           schema:
-            type: string
             description: The migration id to start
+            $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
       requestBody:
         required: true
         content:
@@ -106,9 +149,9 @@ paths:
                 - connector_id
               properties:
                 connector_id:
-                  $ref: '../common.schema.yaml#/components/schemas/ConnectorId'
+                  $ref: '../../common.schema.yaml#/components/schemas/ConnectorId'
                 langsmith_options:
-                  $ref: '../common.schema.yaml#/components/schemas/LangSmithOptions'
+                  $ref: '../../common.schema.yaml#/components/schemas/LangSmithOptions'
       responses:
         200:
           description: Indicates the migration start request has been processed successfully.
@@ -138,8 +181,8 @@ paths:
           in: path
           required: true
           schema:
-            type: string
             description: The migration id to start
+            $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
       responses:
         200:
           description: Indicates the migration stats has been retrieved correctly.
@@ -163,8 +206,8 @@ paths:
           in: path
           required: true
           schema:
-            type: string
             description: The migration id to stop
+            $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
       responses:
         200:
           description: Indicates migration task stop has been processed successfully.
@@ -197,16 +240,24 @@ paths:
           in: path
           required: true
           schema:
-            type: string
             description: The migration id to attach the resources
+            $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
       requestBody:
         required: true
         content:
           application/json:
             schema:
               type: array
               items:
-                $ref: '../../rule_migration.schema.yaml#/components/schemas/RuleMigrationResourceData'
+                allOf:
+                  - $ref: '../../rule_migration.schema.yaml#/components/schemas/RuleMigrationResourceData'
+                  - type: object
+                    required:
+                      - id
+                    properties:
+                      id:
+                        description: The rule resource migration id
+                        $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
       responses:
         200:
           description: Indicates migration resources have been created or updated correctly.
@@ -234,8 +285,8 @@ paths:
           in: path
           required: true
           schema:
-            type: string
             description: The migration id to attach the resources
+            $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
         - name: type
           in: query
           required: false

x-pack/plugins/security_solution/common/siem_migrations/model/api/common.gen.ts → x-pack/plugins/security_solution/common/siem_migrations/model/common.gen.ts

@@ -10,12 +10,21 @@
  * This file is automatically generated by the OpenAPI Generator, @kbn/openapi-generator.
  *
  * info:
- *   title: SIEM Rule Migrations API common components
+ *   title: SIEM Rule Migration common components
  *   version: not applicable
  */
 
 import { z } from '@kbn/zod';
 
+/**
+ * A string that is not empty and does not contain only whitespace
+ */
+export type NonEmptyString = z.infer<typeof NonEmptyString>;
+export const NonEmptyString = z
+  .string()
+  .min(1)
+  .regex(/^(?! *$).+$/);
+
 /**
  * The GenAI connector id to use.
  */

x-pack/plugins/security_solution/common/siem_migrations/model/api/common.schema.yaml → x-pack/plugins/security_solution/common/siem_migrations/model/common.schema.yaml

@@ -1,11 +1,16 @@
 openapi: 3.0.3
 info:
-  title: SIEM Rule Migrations API common components
+  title: SIEM Rule Migration common components
   version: 'not applicable'
 paths: {}
 components:
   x-codegen-enabled: true
   schemas:
+    NonEmptyString:
+      type: string
+      pattern: ^(?! *$).+$
+      minLength: 1
+      description: A string that is not empty and does not contain only whitespace
     ConnectorId:
       type: string
       description: The GenAI connector id to use.