[8.x] [Threat Hunting Investigations] Migrate all timeline routes to …

…OpenAPI types (#190238) (#194606) # Backport This will backport the following commits from `main` to `8.x`: - [[Threat Hunting Investigations] Migrate all timeline routes to OpenAPI types (#190238)](#190238)  ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport)
elastic · Oct 1, 2024 · 1186ed4 · 1186ed4
1 parent 5f04936
commit 1186ed4
Show file tree

Hide file tree

Showing 106 changed files with 2,013 additions and 2,661 deletions.
diff --git a/oas_docs/output/kibana.serverless.staging.yaml b/oas_docs/output/kibana.serverless.staging.yaml
diff --git a/oas_docs/output/kibana.staging.yaml b/oas_docs/output/kibana.staging.yaml
diff --git a/x-pack/plugins/security_solution/common/api/quickstart_client.gen.ts b/x-pack/plugins/security_solution/common/api/quickstart_client.gen.ts
@@ -296,6 +296,10 @@ import type {
   CleanDraftTimelinesRequestBodyInput,
   CleanDraftTimelinesResponse,
 } from './timeline/clean_draft_timelines/clean_draft_timelines_route.gen';
+import type {
+  CopyTimelineRequestBodyInput,
+  CopyTimelineResponse,
+} from './timeline/copy_timeline/copy_timeline_route.gen';
 import type {
   CreateTimelinesRequestBodyInput,
   CreateTimelinesResponse,
@@ -551,6 +555,23 @@ after 30 days. It also deletes other artifacts specific to the migration impleme
       })
       .catch(catchAxiosErrorFormatAndThrow);
   }
+  /**
+    * Copies and returns a timeline or timeline template.
+
+    */
+  async copyTimeline(props: CopyTimelineProps) {
+    this.log.info(`${new Date().toISOString()} Calling API CopyTimeline`);
+    return this.kbnClient
+      .request<CopyTimelineResponse>({
+        path: '/api/timeline/_copy',
+        headers: {
+          [ELASTIC_HTTP_VERSION_HEADER]: '2023-10-31',
+        },
+        method: 'GET',
+        body: props.body,
+      })
+      .catch(catchAxiosErrorFormatAndThrow);
+  }
   async createAlertsIndex() {
     this.log.info(`${new Date().toISOString()} Calling API CreateAlertsIndex`);
     return this.kbnClient
@@ -1946,6 +1967,9 @@ export interface BulkUpsertAssetCriticalityRecordsProps {
 export interface CleanDraftTimelinesProps {
   body: CleanDraftTimelinesRequestBodyInput;
 }
+export interface CopyTimelineProps {
+  body: CopyTimelineRequestBodyInput;
+}
 export interface CreateAlertsMigrationProps {
   body: CreateAlertsMigrationRequestBodyInput;
 }

diff --git a/...ity_solution/common/api/timeline/clean_draft_timelines/clean_draft_timelines_route.gen.ts b/...ity_solution/common/api/timeline/clean_draft_timelines/clean_draft_timelines_route.gen.ts
@@ -16,7 +16,7 @@
 
 import { z } from '@kbn/zod';
 
-import { TimelineType, TimelineResponse } from '../model/components.gen';
+import { TimelineType, PersistTimelineResponse } from '../model/components.gen';
 
 export type CleanDraftTimelinesRequestBody = z.infer<typeof CleanDraftTimelinesRequestBody>;
 export const CleanDraftTimelinesRequestBody = z.object({
@@ -25,10 +25,4 @@ export const CleanDraftTimelinesRequestBody = z.object({
 export type CleanDraftTimelinesRequestBodyInput = z.input<typeof CleanDraftTimelinesRequestBody>;
 
 export type CleanDraftTimelinesResponse = z.infer<typeof CleanDraftTimelinesResponse>;
-export const CleanDraftTimelinesResponse = z.object({
-  data: z.object({
-    persistTimeline: z.object({
-      timeline: TimelineResponse,
-    }),
-  }),
-});
+export const CleanDraftTimelinesResponse = PersistTimelineResponse;
diff --git a/...olution/common/api/timeline/clean_draft_timelines/clean_draft_timelines_route.schema.yaml b/...olution/common/api/timeline/clean_draft_timelines/clean_draft_timelines_route.schema.yaml
@@ -2,13 +2,6 @@ openapi: 3.0.0
 info:
   title: Elastic Security - Timeline - Draft Timeline API
   version: '2023-10-31'
-servers:
-  - url: 'http://{kibana_host}:{port}'
-    variables:
-      kibana_host:
-        default: localhost
-      port:
-        default: '5601'
 paths:
   /api/timeline/_draft:
     post:
@@ -37,19 +30,7 @@ paths:
           content:
             application/json:
               schema:
-                type: object
-                required: [data]
-                properties:
-                  data:
-                    type: object
-                    required: [persistTimeline]
-                    properties:
-                      persistTimeline:
-                        type: object
-                        required: [timeline]
-                        properties:
-                          timeline:
-                            $ref: '../model/components.schema.yaml#/components/schemas/TimelineResponse'
+                $ref: '../model/components.schema.yaml#/components/schemas/PersistTimelineResponse'
         '403':
           description: Indicates that the user does not have the required permissions to create a draft timeline.
           content:

diff --git a/...ck/plugins/security_solution/common/api/timeline/copy_timeline/copy_timeline_route.gen.ts b/...ck/plugins/security_solution/common/api/timeline/copy_timeline/copy_timeline_route.gen.ts
@@ -0,0 +1,29 @@
+/*
+ * Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
+ * or more contributor license agreements. Licensed under the Elastic License
+ * 2.0; you may not use this file except in compliance with the Elastic License
+ * 2.0.
+ */
+
+/*
+ * NOTICE: Do not edit this file manually.
+ * This file is automatically generated by the OpenAPI Generator, @kbn/openapi-generator.
+ *
+ * info:
+ *   title: Elastic Security - Timeline - Copy Timeline API
+ *   version: 2023-10-31
+ */
+
+import { z } from '@kbn/zod';
+
+import { SavedTimeline, PersistTimelineResponse } from '../model/components.gen';
+
+export type CopyTimelineRequestBody = z.infer<typeof CopyTimelineRequestBody>;
+export const CopyTimelineRequestBody = z.object({
+  timeline: SavedTimeline,
+  timelineIdToCopy: z.string(),
+});
+export type CopyTimelineRequestBodyInput = z.input<typeof CopyTimelineRequestBody>;
+
+export type CopyTimelineResponse = z.infer<typeof CopyTimelineResponse>;
+export const CopyTimelineResponse = PersistTimelineResponse;
diff --git a/...ugins/security_solution/common/api/timeline/copy_timeline/copy_timeline_route.schema.yaml b/...ugins/security_solution/common/api/timeline/copy_timeline/copy_timeline_route.schema.yaml
@@ -0,0 +1,34 @@
+openapi: 3.0.0
+info:
+  title: Elastic Security - Timeline - Copy Timeline API
+  version: '2023-10-31'
+paths:
+  /api/timeline/_copy:
+    get:
+      x-labels: [serverless, ess]
+      x-codegen-enabled: true
+      operationId: CopyTimeline
+      summary: Copies timeline or timeline template
+      description: |
+        Copies and returns a timeline or timeline template.
+      tags:
+        - access:securitySolution
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [timeline, timelineIdToCopy]
+              properties:
+                timeline:
+                  $ref: '../model/components.schema.yaml#/components/schemas/SavedTimeline'
+                timelineIdToCopy:
+                  type: string
+      responses:
+        '200':
+          description: Indicates that the timeline has been successfully copied.
+          content:
+            application/json:
+              schema:
+                $ref: '../model/components.schema.yaml#/components/schemas/PersistTimelineResponse'
diff --git a/x-pack/plugins/security_solution/common/api/timeline/copy_timeline/copy_timeline_route.ts b/x-pack/plugins/security_solution/common/api/timeline/copy_timeline/copy_timeline_route.ts
diff --git a/...gins/security_solution/common/api/timeline/create_timelines/create_timelines_route.gen.ts b/...gins/security_solution/common/api/timeline/create_timelines/create_timelines_route.gen.ts
@@ -17,29 +17,23 @@
 import { z } from '@kbn/zod';
 
 import {
+  SavedTimeline,
   TimelineStatus,
   TimelineType,
-  SavedTimeline,
-  TimelineResponse,
+  PersistTimelineResponse,
 } from '../model/components.gen';
 
 export type CreateTimelinesRequestBody = z.infer<typeof CreateTimelinesRequestBody>;
 export const CreateTimelinesRequestBody = z.object({
+  timeline: SavedTimeline,
   status: TimelineStatus.nullable().optional(),
   timelineId: z.string().nullable().optional(),
   templateTimelineId: z.string().nullable().optional(),
   templateTimelineVersion: z.number().nullable().optional(),
   timelineType: TimelineType.nullable().optional(),
   version: z.string().nullable().optional(),
-  timeline: SavedTimeline,
 });
 export type CreateTimelinesRequestBodyInput = z.input<typeof CreateTimelinesRequestBody>;
 
 export type CreateTimelinesResponse = z.infer<typeof CreateTimelinesResponse>;
-export const CreateTimelinesResponse = z.object({
-  data: z.object({
-    persistTimeline: z.object({
-      timeline: TimelineResponse.optional(),
-    }),
-  }),
-});
+export const CreateTimelinesResponse = PersistTimelineResponse;
diff --git a/...security_solution/common/api/timeline/create_timelines/create_timelines_route.schema.yaml b/...security_solution/common/api/timeline/create_timelines/create_timelines_route.schema.yaml
@@ -5,13 +5,6 @@ info:
 externalDocs:
   url: https://www.elastic.co/guide/en/security/current/timeline-api-create.html
   description: Documentation
-servers:
-  - url: 'http://{kibana_host}:{port}'
-    variables:
-      kibana_host:
-        default: localhost
-      port:
-        default: '5601'
 paths:
   /api/timeline:
     post:
@@ -28,9 +21,10 @@ paths:
           application/json:
             schema:
               type: object
-              required:
-                - timeline
+              required: [timeline]
               properties:
+                timeline:
+                  $ref: '../model/components.schema.yaml#/components/schemas/SavedTimeline'
                 status:
                   $ref: '../model/components.schema.yaml#/components/schemas/TimelineStatus'
                   nullable: true
@@ -49,26 +43,13 @@ paths:
                 version:
                   type: string
                   nullable: true
-                timeline:
-                  $ref: '../model/components.schema.yaml#/components/schemas/SavedTimeline'
       responses:
         '200':
           description: Indicates the timeline was successfully created.
           content:
             application/json:
               schema:
-                type: object
-                required: [data]
-                properties:
-                  data:
-                    type: object
-                    required: [persistTimeline]
-                    properties:
-                      persistTimeline:
-                        type: object
-                        properties:
-                          timeline:
-                            $ref: '../model/components.schema.yaml#/components/schemas/TimelineResponse'
+                $ref: '../model/components.schema.yaml#/components/schemas/PersistTimelineResponse'
         '405':
           description: Indicates that there was an error in the timeline creation.
           content:

diff --git a/.../plugins/security_solution/common/api/timeline/create_timelines/create_timelines_route.ts b/.../plugins/security_solution/common/api/timeline/create_timelines/create_timelines_route.ts
diff --git a/...k/plugins/security_solution/common/api/timeline/delete_note/delete_note_route.schema.yaml b/...k/plugins/security_solution/common/api/timeline/delete_note/delete_note_route.schema.yaml
@@ -2,13 +2,6 @@ openapi: 3.0.0
 info:
   title: Elastic Security - Timeline - Notes API
   version: '2023-10-31'
-servers:
-  - url: 'http://{kibana_host}:{port}'
-    variables:
-      kibana_host:
-        default: localhost
-      port:
-        default: '5601'
 paths:
   /api/note:
     delete:

diff --git a/...security_solution/common/api/timeline/delete_timelines/delete_timelines_route.schema.yaml b/...security_solution/common/api/timeline/delete_timelines/delete_timelines_route.schema.yaml
@@ -5,13 +5,6 @@ info:
 externalDocs:
   url: https://www.elastic.co/guide/en/security/current/timeline-api-delete.html
   description: Documentation
-servers:
-  - url: 'http://{kibana_host}:{port}'
-    variables:
-      kibana_host:
-        default: localhost
-      port:
-        default: '5601'
 paths:
   /api/timeline:
     delete:

diff --git a/...security_solution/common/api/timeline/export_timelines/export_timelines_route.schema.yaml b/...security_solution/common/api/timeline/export_timelines/export_timelines_route.schema.yaml
@@ -5,13 +5,6 @@ info:
 externalDocs:
   url: https://www.elastic.co/guide/en/security/current/timeline-api-import.html
   description: Documentation
-servers:
-  - url: 'http://{kibana_host}:{port}'
-    variables:
-      kibana_host:
-        default: localhost
-      port:
-        default: '5601'
 paths:
   /api/timeline/_export:
     post:

diff --git a/...ecurity_solution/common/api/timeline/get_draft_timelines/get_draft_timelines_route.gen.ts b/...ecurity_solution/common/api/timeline/get_draft_timelines/get_draft_timelines_route.gen.ts
@@ -16,7 +16,7 @@
 
 import { z } from '@kbn/zod';
 
-import { TimelineType, TimelineResponse } from '../model/components.gen';
+import { TimelineType, PersistTimelineResponse } from '../model/components.gen';
 
 export type GetDraftTimelinesRequestQuery = z.infer<typeof GetDraftTimelinesRequestQuery>;
 export const GetDraftTimelinesRequestQuery = z.object({
@@ -25,10 +25,4 @@ export const GetDraftTimelinesRequestQuery = z.object({
 export type GetDraftTimelinesRequestQueryInput = z.input<typeof GetDraftTimelinesRequestQuery>;
 
 export type GetDraftTimelinesResponse = z.infer<typeof GetDraftTimelinesResponse>;
-export const GetDraftTimelinesResponse = z.object({
-  data: z.object({
-    persistTimeline: z.object({
-      timeline: TimelineResponse,
-    }),
-  }),
-});
+export const GetDraftTimelinesResponse = PersistTimelineResponse;