[SecuritySolution] Add OpenAPI schema for the timeline resolve enspoi…

…nt (elastic#186373) ## Summary Adds an OpenAPI schema for the timeline resolve endpoint. (Fixes elastic#183810) Co-authored-by: Elastic Machine <[email protected]>
kapral18 · Jul 5, 2024 · 2849829 · 2849829
1 parent 7063806
commit 2849829
Showing 1 changed file with 50 additions and 0 deletions.
diff --git a/...security_solution/common/api/timeline/resolve_timeline/resolve_timeline_route_schema.yaml b/...security_solution/common/api/timeline/resolve_timeline/resolve_timeline_route_schema.yaml
@@ -0,0 +1,50 @@
+openapi: 3.0.0
+info:
+  title: Elastic Security - Timeline - Resolve Timeline API
+  version: 8.9.0
+servers:
+  - url: 'http://{kibana_host}:{port}'
+    variables:
+      kibana_host:
+        default: localhost
+      port:
+        default: '5601'
+paths:
+  /api/timeline:
+    get:
+      operationId: resolveTimeline
+      summary: Get an existing saved timeline or timeline template.
+      tags:
+        - access:securitySolution
+      parameters:
+        - in: query
+          name: template_timeline_id
+          schema:
+            type: string
+          description: The ID of the template timeline to resolve
+        - in: query
+          name: id
+          schema:
+            type: string
+          description: The ID of the timeline to resolve
+      responses:
+        '200':
+          description: The (template) timeline has been found
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  data:
+                    type: object
+                    properties:
+                      getOneTimeline:
+                        oneOf:
+                          - $ref: '../model/components.yaml#/components/schemas/TimelineResponse'
+                          - nullable: true
+                required:
+                  - data
+        '400':
+          description: The request is missing parameters
+        '404':
+          description: The (template) timeline was not found