Skip to content

Commit

Permalink
feat(specs): add startDate and endDate query parameter to list ev…
Browse files Browse the repository at this point in the history
…ents (#2229)
  • Loading branch information
shortcuts authored Nov 9, 2023
1 parent 4d6fe10 commit c2e9fb5
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 22 deletions.
20 changes: 0 additions & 20 deletions specs/ingestion/common/observabilityParameters.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,23 +57,3 @@ 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
10 changes: 10 additions & 0 deletions specs/ingestion/paths/runs/events/events.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,16 @@ get:
- $ref: '../../../common/observabilityParameters.yml#/eventType'
- $ref: '../../../common/observabilityParameters.yml#/eventSort'
- $ref: '../../../common/parameters.yml#/order'
- name: startDate
in: query
description: The start date (in RFC3339 format) of the events fetching window. Defaults to 'now'-3 hours if omitted.
schema:
type: string
- name: endDate
in: query
description: The end date (in RFC3339 format) of the events fetching window. Defaults to 'now' days if omitted.
schema:
type: string
responses:
'200':
description: OK
Expand Down
12 changes: 10 additions & 2 deletions specs/ingestion/paths/runs/runs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,16 @@ 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'
- name: startDate
in: query
description: The start date (in RFC3339 format) of the runs fetching window. Defaults to 'now'-7 days if omitted.
schema:
type: string
- name: endDate
in: query
description: The end date (in RFC3339 format) of the runs fetching window. Defaults to 'now' days if omitted.
schema:
type: string
responses:
'200':
description: OK
Expand Down

0 comments on commit c2e9fb5

Please sign in to comment.