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

Add endpoint to get corrections applied to an SLO #689

Merged
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
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.5.1.dev2",
"regenerated": "2021-11-25 12:06:40.591206",
"spec_repo_commit": "765200a"
"regenerated": "2021-11-25 13:34:04.967958",
"spec_repo_commit": "71029a4"
},
"v2": {
"apigentools_version": "1.5.1.dev2",
"regenerated": "2021-11-25 12:06:41.129844",
"spec_repo_commit": "765200a"
"regenerated": "2021-11-25 13:34:05.364778",
"spec_repo_commit": "71029a4"
}
}
}
83 changes: 83 additions & 0 deletions .generator/schemas/v1/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7654,6 +7654,10 @@ components:
properties:
category:
$ref: '#/components/schemas/SLOCorrectionCategory'
created_at:
description: The epoch timestamp of when the correction was created at
format: int64
type: integer
creator:
$ref: '#/components/schemas/Creator'
description:
Expand All @@ -7670,6 +7674,24 @@ components:
description: Ending time of the correction in epoch seconds.
format: int64
type: integer
modified_at:
description: The epoch timestamp of when the correction was modified at
format: int64
type: integer
modifier:
description: Modifier of the object.
nullable: true
properties:
email:
description: Email of the Modifier.
type: string
handle:
description: Handle of the Modifier.
type: string
name:
description: Name of the Modifier.
type: string
type: object
rrule:
description: Recurrence rules as defined in the iCalendar RFC 5545.
example: RRULE:FREQ=DAILY;INTERVAL=10;COUNT=5
Expand Down Expand Up @@ -22102,6 +22124,57 @@ paths:
x-menu-order: 3
x-undo:
type: idempotent
/api/v1/slo/{slo_id}/corrections:
get:
description: Get corrections applied to an SLO
operationId: GetSLOCorrections
parameters:
- description: The ID of the service level objective object.
in: path
name: slo_id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SLOCorrectionListResponse'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Bad Request
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Forbidden
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Not Found
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ: []
summary: Get Corrections For an SLO
tags:
- Service Level Objectives
x-menu-order: 6
x-undo:
type: safe
x-unstable: '**Note**: This endpoint is in public beta.

If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v1/slo/{slo_id}/history:
get:
description: "Get a specific SLO\u2019s history, regardless of its SLO type.\n\nThe
Expand Down Expand Up @@ -22143,6 +22216,16 @@ paths:
maximum: 100
minimum: 0
type: number
- description: 'Defaults to `true`. If any SLO corrections are applied and this
parameter is set to `false`,

then the corrections will not be applied and the SLI values will not be
affected.'
in: query
name: apply_correction
required: false
schema:
type: boolean
responses:
'200':
content:
Expand Down
2 changes: 2 additions & 0 deletions docs/v1/README.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

25 changes: 14 additions & 11 deletions docs/v1/SLOCorrectionResponseAttributes.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 14 additions & 0 deletions docs/v1/SLOCorrectionResponseAttributesModifier.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading