Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Nov 9, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions specs/ingestion/common/schemas/common.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 2 additions & 0 deletions specs/ingestion/common/schemas/run.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ RunListResponse:
$ref: '#/Run'
pagination:
$ref: './pagination.yml#/Pagination'
window:
$ref: './common.yml#/Window'
required:
- runs
- pagination
Expand Down
3 changes: 3 additions & 0 deletions specs/ingestion/paths/runs/events/events.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'