feat(specs): add window parameter to observability responses (#2223)

algolia · Nov 9, 2023 · 15b81fe · 15b81fe
1 parent 54fb30d
commit 15b81fe
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/specs/ingestion/common/schemas/common.yml b/specs/ingestion/common/schemas/common.yml
@@ -60,3 +60,18 @@ eventID:
 name:
   type: string
   description: An human readable name describing the object.
+
+Window:
+  type: object
+  additionalProperties: false
+  description: The window parameter represents the holds the dates used to query the Observability data from the database in a given window.
+  properties:
+    startDate:
+      type: string
+      description: A date in format RFC3339 representing the oldest possible data in query window.
+    endDate:
+      type: string
+      description: A date in format RFC3339 representing the newest possible data in query window.
+  required:
+    - startDate
+    - endDate
diff --git a/specs/ingestion/common/schemas/run.yml b/specs/ingestion/common/schemas/run.yml
@@ -21,6 +21,8 @@ RunListResponse:
         $ref: '#/Run'
     pagination:
       $ref: './pagination.yml#/Pagination'
+    window:
+      $ref: './common.yml#/Window'
   required:
     - runs
     - pagination

diff --git a/specs/ingestion/paths/runs/events/events.yml b/specs/ingestion/paths/runs/events/events.yml
@@ -28,8 +28,11 @@ get:
                   $ref: '../../../common/schemas/event.yml#/Event'
               pagination:
                 $ref: '../../../common/schemas/pagination.yml#/Pagination'
+              window:
+                $ref: '../../../common/schemas/common.yml#/Window'
             required:
               - events
               - pagination
+              - window
     '400':
       $ref: '../../../../common/responses/BadRequest.yml'