[SecuritySolution][Onboarding] Siem migration start card and flyout - Part 1

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

@@ -356,6 +356,7 @@ import type {
   ResolveTimelineResponse,
 } from './timeline/resolve_timeline/resolve_timeline_route.gen';
 import type {
+  CreateRuleMigrationRequestParamsInput,
   CreateRuleMigrationRequestBodyInput,
   CreateRuleMigrationResponse,
   GetAllStatsRuleMigrationResponse,
@@ -686,7 +687,7 @@ If a record already exists for the specified entity, that record is overwritten
     this.log.info(`${new Date().toISOString()} Calling API CreateRuleMigration`);
     return this.kbnClient
       .request<CreateRuleMigrationResponse>({
-        path: '/internal/siem_migrations/rules',
+        path: replaceParams('/internal/siem_migrations/rules/{migration_id}', props.params),
         headers: {
           [ELASTIC_HTTP_VERSION_HEADER]: '1',
         },
@@ -2267,6 +2268,7 @@ export interface CreateRuleProps {
   body: CreateRuleRequestBodyInput;
 }
 export interface CreateRuleMigrationProps {
+  params: CreateRuleMigrationRequestParamsInput;
   body: CreateRuleMigrationRequestBodyInput;
 }
 export interface CreateTimelinesProps {

x-pack/plugins/security_solution/common/siem_migrations/constants.ts

@@ -11,6 +11,8 @@ export const SIEM_MIGRATIONS_PATH = '/internal/siem_migrations' as const;
 export const SIEM_RULE_MIGRATIONS_PATH = `${SIEM_MIGRATIONS_PATH}/rules` as const;
 
 export const SIEM_RULE_MIGRATIONS_ALL_STATS_PATH = `${SIEM_RULE_MIGRATIONS_PATH}/stats` as const;
+export const SIEM_RULE_MIGRATION_CREATE_PATH =
+  `${SIEM_RULE_MIGRATIONS_PATH}/{migration_id?}` as const;
 export const SIEM_RULE_MIGRATION_PATH = `${SIEM_RULE_MIGRATIONS_PATH}/{migration_id}` as const;
 export const SIEM_RULE_MIGRATION_START_PATH = `${SIEM_RULE_MIGRATION_PATH}/start` as const;
 export const SIEM_RULE_MIGRATION_RETRY_PATH = `${SIEM_RULE_MIGRATION_PATH}/retry` as const;

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

@@ -17,19 +17,27 @@
 import { z } from '@kbn/zod';
 import { ArrayFromString } from '@kbn/zod-helpers';
 
+import { NonEmptyString, ConnectorId, LangSmithOptions } from '../../common.gen';
 import {
-  OriginalRule,
   ElasticRulePartial,
   RuleMigrationTranslationResult,
   RuleMigrationComments,
   RuleMigrationTaskStats,
+  OriginalRule,
   RuleMigration,
   RuleMigrationTranslationStats,
   RuleMigrationResourceData,
   RuleMigrationResourceType,
   RuleMigrationResource,
 } from '../../rule_migration.gen';
-import { NonEmptyString, ConnectorId, LangSmithOptions } from '../../common.gen';
+
+export type CreateRuleMigrationRequestParams = z.infer<typeof CreateRuleMigrationRequestParams>;
+export const CreateRuleMigrationRequestParams = z.object({
+  migration_id: NonEmptyString.optional(),
+});
+export type CreateRuleMigrationRequestParamsInput = z.input<
+  typeof CreateRuleMigrationRequestParams
+>;
 
 export type CreateRuleMigrationRequestBody = z.infer<typeof CreateRuleMigrationRequestBody>;
 export const CreateRuleMigrationRequestBody = z.array(OriginalRule);

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

@@ -4,38 +4,7 @@ info:
   version: '1'
 paths:
   # Rule migrations APIs
-
   /internal/siem_migrations/rules:
-    post:
-      summary: Creates a new rule migration
-      operationId: CreateRuleMigration
-      x-codegen-enabled: true
-      x-internal: true
-      description: Creates a new SIEM rules migration using the original vendor rules provided
-      tags:
-        - SIEM Rule Migrations
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              type: array
-              items:
-                $ref: '../../rule_migration.schema.yaml#/components/schemas/OriginalRule'
-      responses:
-        200:
-          description: Indicates migration have been created correctly.
-          content:
-            application/json:
-              schema:
-                type: object
-                required:
-                  - migration_id
-                properties:
-                  migration_id:
-                    description: The migration id created.
-                    $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
-
     put:
       summary: Updates rules migrations
       operationId: UpdateRuleMigration
@@ -81,95 +50,64 @@ paths:
                     type: boolean
                     description: Indicates rules migrations have been updated.
 
-  /internal/siem_migrations/rules/{migration_id}/install:
-    post:
-      summary: Installs translated migration rules
-      operationId: InstallMigrationRules
+  /internal/siem_migrations/rules/stats:
+    get:
+      summary: Retrieves the stats for all rule migrations
+      operationId: GetAllStatsRuleMigration
       x-codegen-enabled: true
-      description: Installs migration rules
+      x-internal: true
+      description: Retrieves the rule migrations stats for all migrations stored in the system
       tags:
         - SIEM Rule Migrations
-      parameters:
-        - name: migration_id
-          in: path
-          required: true
-          schema:
-            description: The migration id to isnstall rules for
-            $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
-      requestBody:
-        required: true
-        content:
-          application/json:
-            schema:
-              type: array
-              items:
-                description: The rule migration id
-                $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
       responses:
         200:
-          description: Indicates rules migrations have been installed correctly.
+          description: Indicates rule migrations have been retrieved correctly.
           content:
             application/json:
               schema:
-                type: object
-                required:
-                  - installed
-                properties:
-                  installed:
-                    type: boolean
-                    description: Indicates rules migrations have been installed.
+                type: array
+                items:
+                  $ref: '../../rule_migration.schema.yaml#/components/schemas/RuleMigrationTaskStats'
 
-  /internal/siem_migrations/rules/{migration_id}/install_translated:
+  ## Specific rule migration APIs
+
+  /internal/siem_migrations/rules/{migration_id}:
     post:
-      summary: Installs all translated migration rules
-      operationId: InstallTranslatedMigrationRules
+      summary: Creates a new rule migration
+      operationId: CreateRuleMigration
       x-codegen-enabled: true
-      description: Installs all translated migration rules
+      x-internal: true
+      description: Creates a new SIEM rules migration using the original vendor rules provided
       tags:
         - SIEM Rule Migrations
       parameters:
         - name: migration_id
           in: path
-          required: true
+          required: false
           schema:
-            description: The migration id to install translated rules for
+            description: The migration id to create rules for
             $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                $ref: '../../rule_migration.schema.yaml#/components/schemas/OriginalRule'
       responses:
         200:
-          description: Indicates rules migrations have been installed correctly.
+          description: Indicates migration have been created correctly.
           content:
             application/json:
               schema:
                 type: object
                 required:
-                  - installed
+                  - migration_id
                 properties:
-                  installed:
-                    type: boolean
-                    description: Indicates rules migrations have been installed.
-
-  /internal/siem_migrations/rules/stats:
-    get:
-      summary: Retrieves the stats for all rule migrations
-      operationId: GetAllStatsRuleMigration
-      x-codegen-enabled: true
-      x-internal: true
-      description: Retrieves the rule migrations stats for all migrations stored in the system
-      tags:
-        - SIEM Rule Migrations
-      responses:
-        200:
-          description: Indicates rule migrations have been retrieved correctly.
-          content:
-            application/json:
-              schema:
-                type: array
-                items:
-                  $ref: '../../rule_migration.schema.yaml#/components/schemas/RuleMigrationTaskStats'
-
-  ## Specific rule migration APIs
-
-  /internal/siem_migrations/rules/{migration_id}:
+                  migration_id:
+                    description: The migration id created.
+                    $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
     get:
       summary: Retrieves all the rules of a migration
       operationId: GetRuleMigration
@@ -222,6 +160,73 @@ paths:
         204:
           description: Indicates the migration id was not found.
 
+  /internal/siem_migrations/rules/{migration_id}/install:
+    post:
+      summary: Installs translated migration rules
+      operationId: InstallMigrationRules
+      x-codegen-enabled: true
+      description: Installs migration rules
+      tags:
+        - SIEM Rule Migrations
+      parameters:
+        - name: migration_id
+          in: path
+          required: true
+          schema:
+            description: The migration id to install rules for
+            $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                description: The rule migration id
+                $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
+      responses:
+        200:
+          description: Indicates rules migrations have been installed correctly.
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - installed
+                properties:
+                  installed:
+                    type: boolean
+                    description: Indicates rules migrations have been installed.
+
+  /internal/siem_migrations/rules/{migration_id}/install_translated:
+    post:
+      summary: Installs all translated migration rules
+      operationId: InstallTranslatedMigrationRules
+      x-codegen-enabled: true
+      description: Installs all translated migration rules
+      tags:
+        - SIEM Rule Migrations
+      parameters:
+        - name: migration_id
+          in: path
+          required: true
+          schema:
+            description: The migration id to install translated rules for
+            $ref: '../../common.schema.yaml#/components/schemas/NonEmptyString'
+      responses:
+        200:
+          description: Indicates rules migrations have been installed correctly.
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - installed
+                properties:
+                  installed:
+                    type: boolean
+                    description: Indicates rules migrations have been installed.
+
   /internal/siem_migrations/rules/{migration_id}/start:
     put:
       summary: Starts a rule migration

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

@@ -20,10 +20,7 @@ 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(/^(?! *$).+$/);
+export const NonEmptyString = z.string().min(1).regex(/\S+/);
 
 /**
  * The GenAI connector id to use.

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

@@ -8,7 +8,7 @@ components:
   schemas:
     NonEmptyString:
       type: string
-      pattern: ^(?! *$).+$
+      pattern: \S+
       minLength: 1
       description: A string that is not empty and does not contain only whitespace
     ConnectorId:

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

@@ -24,6 +24,19 @@ import { NonEmptyString } from './common.gen';
 export type OriginalRuleVendor = z.infer<typeof OriginalRuleVendor>;
 export const OriginalRuleVendor = z.literal('splunk');
 
+/**
+ * The original rule annotations containing additional information.
+ */
+export type OriginalRuleAnnotations = z.infer<typeof OriginalRuleAnnotations>;
+export const OriginalRuleAnnotations = z
+  .object({
+    /**
+     * The original rule Mitre Attack IDs.
+     */
+    mitre_attack: z.array(z.string()).optional(),
+  })
+  .catchall(z.unknown());
+
 /**
  * The original rule to migrate.
  */
@@ -40,23 +53,23 @@ export const OriginalRule = z.object({
   /**
    * The original rule name.
    */
-  title: z.string(),
+  title: NonEmptyString,
   /**
    * The original rule description.
    */
   description: z.string(),
   /**
    * The original rule query.
    */
-  query: z.string(),
+  query: z.string().min(1),
   /**
    * The original rule query language.
    */
   query_language: z.string(),
   /**
-   * The original rule Mitre Attack technique IDs.
+   * The original rule annotations containing additional information.
    */
-  mitre_attack_ids: z.array(z.string()).optional(),
+  annotations: OriginalRuleAnnotations.optional(),
 });
 
 /**