Definitions Update search

Author: cibot

alsdkdefs/apis/search/search.v2.yaml

@@ -2,7 +2,7 @@ openapi: 3.0.2
 info:
   title: Alert Logic Universal Search Service
   version: '2.0'
-  description: "Service for submitting searches and getting their results.\nThis API is datatype agnostic as the selection of which datatype to search over is now done in the SQL via the FROM part of the query. "
+  description: "Service for submitting searches and getting their results.\nThis API is datatype-agnostic as the selection of which datatype to search over is now done in the SQL via the FROM part of the query. "
 servers:
   - url: 'https://api.global-services.global.alertlogic.com'
     description: production
@@ -17,7 +17,7 @@ paths:
       tags: []
       responses:
         '201':
-          description: Created
+          description: The search has been created and is executing.
           content:
             application/json:
               schema:
@@ -62,6 +62,24 @@ paths:
               - report
             default: auto
           in: query
+        - name: timeframe
+          in: query
+          description: 'A number of seconds back from the current time to query.  I.e. a value of 3600 indicates that the
+                        query should start from 1 hour ago (3600 seconds ago) until now.'
+          schema:
+            type: integer
+            minimum: 1
+            maximum: 31622400   # NOTE: This comes from MAX_TIMEFRAME in search_lib
+        - name: start
+          in: query
+          description: 'The start of the time period to search as a Unix epoch timestamp.'
+          schema:
+            $ref: '#/components/schemas/EpochTimestamp'
+        - name: end
+          in: query
+          description: 'The end of the time period to search as a Unix epoch timestamp.'
+          schema:
+            $ref: '#/components/schemas/EpochTimestamp'
       requestBody:
         content:
           text/plain:
@@ -95,7 +113,7 @@ paths:
             default: 'false'
           in: query
           description: Return search execution details
-        - name: offest
+        - name: offset
           schema:
             type: integer
           in: query
@@ -161,26 +179,62 @@ components:
       required: true
       description: AIMS Account Id
   schemas:
+    EpochTimestamp:
+      type: integer
+      minimum: 0
+    MessagesParams:
+      title: MessagesParams
+      type: object
+      required:
+        - ids
+      properties:
+        ids:
+          type: array
+          items:
+            type: string
+        fields:
+          type: string
+        tokens_offsets:
+          type: string
+          enum:
+            - 'true'
+            - 'false'
+          default: 'false'
+        properties:
+          type: string
+          enum:
+            - 'true'
+            - 'false'
+          default: 'false'
+    MessagesResponse:
+      title: Messages
+      type: array
+      required:
+        - id
+        - fields
+      items:
+        type: object
+        properties:
+          id:
+            type: object
+            properties:
+              msgid:
+                type: string
+              aid:
+                type: integer
+              account:
+                type: integer
+          fields:
+            type: object
+          error:
+            type: object
     SearchCreated:
       title: SearchCreated
       type: object
       properties:
         search_uuid:
           type: string
           description: The unique id for the search request
-    SearchFailed:
-      title: SearchFailed
-      type: object
-      properties:
-        search_status:
-          type: string
-          enum:
-            - failed
-        status_details:
-          type: string
-          description: 'User friendly status '
-        details:
-          $ref: '#/components/schemas/SearchDetails'
     SearchDetails:
       title: SearchDetails
       type: object
@@ -202,6 +256,19 @@ components:
           description: Last update to the search in Epoch
         stats:
           $ref: '#/components/schemas/SearchStats'
+    SearchFailed:
+      title: SearchFailed
+      type: object
+      properties:
+        search_status:
+          type: string
+          enum:
+            - failed
+        status_details:
+          type: string
+          description: 'User friendly status '
+        details:
+          $ref: '#/components/schemas/SearchDetails'
     SearchStats:
       title: SearchStats
       type: object
@@ -234,52 +301,6 @@ components:
           type: integer
         sorts_executed:
           type: integer
-    MessagesParams:
-      title: MessagesParams
-      type: object
-      required:
-        - ids
-      properties:
-        ids:
-          type: array
-          items:
-            type: string
-        fields:
-          type: string
-        tokens_offsets:
-          type: string
-          enum:
-            - 'true'
-            - 'false'
-          default: 'false'
-        properties:
-          type: string
-          enum:
-            - 'true'
-            - 'false'
-          default: 'false'
-    MessagesResponse:
-      title: Messages
-      type: array
-      required:
-        - id
-        - fields
-      items:
-        type: object
-        properties:
-          id:
-            type: object
-            properties:
-              msgid:
-                type: string
-              aid:
-                type: integer
-              account:
-                type: integer
-          fields:
-            type: object
-          error:
-            type: object
   securitySchemes:
     X-AIMS-Auth-Token:
       name: X-AIMS-Auth-Token