fix(specs): add query params for observability (#1277)

Author: millotp

specs/ingestion/common/observabilityParameters.yml

@@ -0,0 +1,33 @@
+eventStatus:
+  name: status
+  in: query
+  description: Filter the status of the events.
+  schema:
+    type: array
+    items:
+      $ref: './schemas/event.yml#/EventStatus'
+
+eventType:
+  name: type
+  in: query
+  description: Filter the type of the events.
+  schema:
+    type: array
+    items:
+      $ref: './schemas/event.yml#/EventType'
+
+runStatus:
+  name: status
+  in: query
+  description: Filter the status of the runs.
+  schema:
+    type: array
+    items:
+      $ref: './schemas/run.yml#/RunStatus'
+
+taskID:
+  name: taskID
+  in: query
+  description: Filter by taskID.
+  schema:
+    type: string

specs/ingestion/common/schemas/event.yml

@@ -30,4 +30,4 @@ EventStatus:
 
 EventType:
   type: string
-  enum: ['fetch', 'record', 'internal']
+  enum: ['fetch', 'record', 'log']

specs/ingestion/common/schemas/run.yml

@@ -67,7 +67,7 @@ Run:
 
 RunStatus:
   type: string
-  enum: ['created', 'started', 'finished']
+  enum: ['created', 'started', 'idled', 'finished']
 
 RunOutcome:
   type: string

specs/ingestion/common/schemas/source.yml

@@ -180,9 +180,7 @@ SourceUpdateJson:
   required:
     - url
 
-
 SourceUpdateInput:
   oneOf:
     - $ref: '#/SourceUpdateCommercetools'
     - $ref: '#/SourceUpdateJson'
-

specs/ingestion/paths/runs/events/events.yml

@@ -8,6 +8,8 @@ get:
     - $ref: '../../../common/parameters.yml#/runID'
     - $ref: '../../../common/parameters.yml#/itemsPerPage'
     - $ref: '../../../common/parameters.yml#/page'
+    - $ref: '../../../common/observabilityParameters.yml#/eventStatus'
+    - $ref: '../../../common/observabilityParameters.yml#/eventType'
   responses:
     '200':
       description: OK
@@ -22,10 +24,7 @@ get:
                 type: array
                 items:
                   $ref: '../../../common/schemas/event.yml#/Event'
-              pagination:
-                $ref: '../../../common/schemas/pagination.yml#/Pagination'
             required:
               - events
-              - pagination
     '400':
       $ref: '../../../../common/responses/BadRequest.yml'

specs/ingestion/paths/runs/runs.yml

@@ -7,6 +7,8 @@ get:
   parameters:
     - $ref: '../../common/parameters.yml#/itemsPerPage'
     - $ref: '../../common/parameters.yml#/page'
+    - $ref: '../../common/observabilityParameters.yml#/runStatus'
+    - $ref: '../../common/observabilityParameters.yml#/taskID'
   responses:
     '200':
       description: OK

specs/ingestion/paths/runs/tasks/taskID.yml

@@ -83,5 +83,3 @@ paths:
     $ref: 'paths/runs/events/events.yml'
   /1/runs/{runID}/events/{eventID}:
     $ref: 'paths/runs/events/eventID.yml'
-  /1/runs/tasks/{taskID}:
-    $ref: 'paths/runs/tasks/taskID.yml'