feat(specs): add startDate and endDate parameters to Ingestion API (

#1614)
algolia · Jun 13, 2023 · 81401ee · 81401ee
1 parent c63ec0a
commit 81401ee
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/specs/ingestion/common/observabilityParameters.yml b/specs/ingestion/common/observabilityParameters.yml
@@ -57,3 +57,23 @@ eventSortKeys:
   type: string
   description: Used to sort the Event list endpoint.
   enum: [status, type, publishedAt]
+
+startDate:
+  name: startDate
+  in: query
+  description: >
+    The start date (in RFC3339 format) of the runs fetching window.
+
+    Defaults to 'now'-7 days if omitted. The timespan between `startDate` and `endDate` must be smaller than 7 days.
+  schema:
+    type: string
+
+endDate:
+  name: endDate
+  in: query
+  description: >
+    The end date (in RFC3339 format) of the runs fetching window.
+
+    Defaults to 'now' days if omitted. The timespan between `startDate` and `endDate` must be smaller than 7 days.
+  schema:
+    type: string
diff --git a/specs/ingestion/paths/runs/runs.yml b/specs/ingestion/paths/runs/runs.yml
@@ -11,6 +11,8 @@ get:
     - $ref: '../../common/observabilityParameters.yml#/taskID'
     - $ref: '../../common/observabilityParameters.yml#/runSort'
     - $ref: '../../common/parameters.yml#/order'
+    - $ref: '../../common/observabilityParameters.yml#/startDate'
+    - $ref: '../../common/observabilityParameters.yml#/endDate'
   responses:
     '200':
       description: OK