Skip to content

Commit 818e83e

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit fb239172 of spec repo
1 parent 33b1ea9 commit 818e83e

File tree

39 files changed

+2043
-4
lines changed

39 files changed

+2043
-4
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2024-04-08 20:24:15.604341",
8-
"spec_repo_commit": "037e376a"
7+
"regenerated": "2024-04-09 15:46:31.473871",
8+
"spec_repo_commit": "fb239172"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-04-08 20:24:15.623228",
13-
"spec_repo_commit": "037e376a"
12+
"regenerated": "2024-04-09 15:46:31.492571",
13+
"spec_repo_commit": "fb239172"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 277 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -411,6 +411,13 @@ components:
411411
required: true
412412
schema:
413413
type: string
414+
ReportID:
415+
description: The ID of the report job.
416+
in: path
417+
name: report_id
418+
required: true
419+
schema:
420+
type: string
414421
ResourceID:
415422
description: 'Identifier, formatted as `type:id`. Supported types: `connection`,
416423
`dashboard`, `notebook`, `security-rule`, `slo`.'
@@ -16574,6 +16581,74 @@ components:
1657416581
type: string
1657516582
x-enum-varnames:
1657616583
- SAML_ASSERTION_ATTRIBUTES
16584+
SLOReportInterval:
16585+
description: The frequency at which report data is to be generated.
16586+
enum:
16587+
- weekly
16588+
- monthly
16589+
example: weekly
16590+
type: string
16591+
x-enum-varnames:
16592+
- WEEKLY
16593+
- MONTHLY
16594+
SLOReportPostResponse:
16595+
description: The SLO report response.
16596+
properties:
16597+
data:
16598+
$ref: '#/components/schemas/SLOReportPostResponseData'
16599+
type: object
16600+
SLOReportPostResponseData:
16601+
description: The data portion of the SLO report response.
16602+
properties:
16603+
id:
16604+
description: The ID of the report job.
16605+
example: dc8d92aa-e0af-11ee-af21-1feeaccaa3a3
16606+
type: string
16607+
type:
16608+
description: The type of ID.
16609+
example: report_id
16610+
type: string
16611+
type: object
16612+
SLOReportStatus:
16613+
description: The status of the SLO report job.
16614+
enum:
16615+
- in_progress
16616+
- completed
16617+
- completed_with_errors
16618+
- failed
16619+
example: completed
16620+
type: string
16621+
x-enum-varnames:
16622+
- IN_PROGRESS
16623+
- COMPLETED
16624+
- COMPLETED_WITH_ERRORS
16625+
- FAILED
16626+
SLOReportStatusGetResponse:
16627+
description: The SLO report status response.
16628+
properties:
16629+
data:
16630+
$ref: '#/components/schemas/SLOReportStatusGetResponseData'
16631+
type: object
16632+
SLOReportStatusGetResponseAttributes:
16633+
description: The attributes portion of the SLO report status response.
16634+
properties:
16635+
status:
16636+
$ref: '#/components/schemas/SLOReportStatus'
16637+
type: object
16638+
SLOReportStatusGetResponseData:
16639+
description: The data portion of the SLO report status response.
16640+
properties:
16641+
attributes:
16642+
$ref: '#/components/schemas/SLOReportStatusGetResponseAttributes'
16643+
id:
16644+
description: The ID of the report job.
16645+
example: dc8d92aa-e0af-11ee-af21-1feeaccaa3a3
16646+
type: string
16647+
type:
16648+
description: The type of ID.
16649+
example: report_id
16650+
type: string
16651+
type: object
1657716652
ScalarColumn:
1657816653
description: A single column in a scalar query response.
1657916654
oneOf:
@@ -20216,6 +20291,53 @@ components:
2021620291
- channel_name
2021720292
- redirect_url
2021820293
type: object
20294+
SloReportCreateRequest:
20295+
description: The SLO report request body.
20296+
properties:
20297+
data:
20298+
$ref: '#/components/schemas/SloReportCreateRequestData'
20299+
required:
20300+
- data
20301+
type: object
20302+
SloReportCreateRequestAttributes:
20303+
description: The attributes portion of the SLO report request.
20304+
properties:
20305+
from_ts:
20306+
description: The `from` timestamp for the report in epoch seconds.
20307+
example: 1690901870
20308+
format: int64
20309+
type: integer
20310+
interval:
20311+
$ref: '#/components/schemas/SLOReportInterval'
20312+
query:
20313+
description: The query string used to filter SLO results. Some examples
20314+
of queries include `service:<service-name>` and `slo-name`.
20315+
example: slo_type:metric
20316+
type: string
20317+
timezone:
20318+
description: The timezone used to determine the start and end of each interval.
20319+
For example, weekly intervals start at 12am on Sunday in the specified
20320+
timezone.
20321+
example: America/New_York
20322+
type: string
20323+
to_ts:
20324+
description: The `to` timestamp for the report in epoch seconds.
20325+
example: 1706803070
20326+
format: int64
20327+
type: integer
20328+
required:
20329+
- query
20330+
- from_ts
20331+
- to_ts
20332+
type: object
20333+
SloReportCreateRequestData:
20334+
description: The data portion of the SLO report request.
20335+
properties:
20336+
attributes:
20337+
$ref: '#/components/schemas/SloReportCreateRequestAttributes'
20338+
required:
20339+
- attributes
20340+
type: object
2021920341
SortDirection:
2022020342
default: desc
2022120343
description: The direction to sort by.
@@ -33715,6 +33837,149 @@ paths:
3371533837
- Incident Services
3371633838
x-codegen-request-body-name: body
3371733839
x-unstable: '**Note**: This endpoint is deprecated.'
33840+
/api/v2/slo/report:
33841+
post:
33842+
description: 'Create a job to generate an SLO report. The report job is processed
33843+
asynchronously and eventually results in a CSV report being available for
33844+
download.
33845+
33846+
33847+
Check the status of the job and download the CSV report using the returned
33848+
`report_id`.'
33849+
operationId: CreateSLOReportJob
33850+
requestBody:
33851+
content:
33852+
application/json:
33853+
schema:
33854+
$ref: '#/components/schemas/SloReportCreateRequest'
33855+
description: Create SLO report job request body.
33856+
required: true
33857+
responses:
33858+
'200':
33859+
content:
33860+
application/json:
33861+
schema:
33862+
$ref: '#/components/schemas/SLOReportPostResponse'
33863+
description: OK
33864+
'400':
33865+
content:
33866+
application/json:
33867+
schema:
33868+
$ref: '#/components/schemas/APIErrorResponse'
33869+
description: Bad Request
33870+
'403':
33871+
content:
33872+
application/json:
33873+
schema:
33874+
$ref: '#/components/schemas/APIErrorResponse'
33875+
description: Forbidden
33876+
'429':
33877+
$ref: '#/components/responses/TooManyRequestsResponse'
33878+
security:
33879+
- apiKeyAuth: []
33880+
appKeyAuth: []
33881+
- AuthZ:
33882+
- slos_read
33883+
summary: Create a new SLO report
33884+
tags:
33885+
- Service Level Objectives
33886+
x-codegen-request-body-name: body
33887+
x-unstable: '**Note**: This feature is in private beta. To request access, use
33888+
the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
33889+
docs.'
33890+
/api/v2/slo/report/{report_id}/download:
33891+
get:
33892+
description: 'Download an SLO report. This can only be performed after the report
33893+
job has completed.
33894+
33895+
33896+
Reports are not guaranteed to exist indefinitely. Datadog recommends that
33897+
you download the report as soon as it is available.'
33898+
operationId: GetSLOReport
33899+
parameters:
33900+
- $ref: '#/components/parameters/ReportID'
33901+
responses:
33902+
'200':
33903+
content:
33904+
text/csv:
33905+
schema:
33906+
type: string
33907+
description: OK
33908+
'400':
33909+
content:
33910+
application/json:
33911+
schema:
33912+
$ref: '#/components/schemas/APIErrorResponse'
33913+
description: Bad Request
33914+
'403':
33915+
content:
33916+
application/json:
33917+
schema:
33918+
$ref: '#/components/schemas/APIErrorResponse'
33919+
description: Forbidden
33920+
'404':
33921+
content:
33922+
application/json:
33923+
schema:
33924+
$ref: '#/components/schemas/APIErrorResponse'
33925+
description: Not Found
33926+
'429':
33927+
$ref: '#/components/responses/TooManyRequestsResponse'
33928+
security:
33929+
- apiKeyAuth: []
33930+
appKeyAuth: []
33931+
- AuthZ:
33932+
- slos_read
33933+
summary: Get SLO report
33934+
tags:
33935+
- Service Level Objectives
33936+
x-unstable: '**Note**: This feature is in private beta. To request access, use
33937+
the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
33938+
docs.'
33939+
/api/v2/slo/report/{report_id}/status:
33940+
get:
33941+
description: Get the status of the SLO report job.
33942+
operationId: GetSLOReportJobStatus
33943+
parameters:
33944+
- $ref: '#/components/parameters/ReportID'
33945+
responses:
33946+
'200':
33947+
content:
33948+
application/json:
33949+
schema:
33950+
$ref: '#/components/schemas/SLOReportStatusGetResponse'
33951+
description: OK
33952+
'400':
33953+
content:
33954+
application/json:
33955+
schema:
33956+
$ref: '#/components/schemas/APIErrorResponse'
33957+
description: Bad Request
33958+
'403':
33959+
content:
33960+
application/json:
33961+
schema:
33962+
$ref: '#/components/schemas/APIErrorResponse'
33963+
description: Forbidden
33964+
'404':
33965+
content:
33966+
application/json:
33967+
schema:
33968+
$ref: '#/components/schemas/APIErrorResponse'
33969+
description: Not Found
33970+
'429':
33971+
$ref: '#/components/responses/TooManyRequestsResponse'
33972+
security:
33973+
- apiKeyAuth: []
33974+
appKeyAuth: []
33975+
- AuthZ:
33976+
- slos_read
33977+
summary: Get SLO report status
33978+
tags:
33979+
- Service Level Objectives
33980+
x-unstable: '**Note**: This feature is in private beta. To request access, use
33981+
the request access form in the [Service Level Objectives](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export)
33982+
docs.'
3371833983
/api/v2/spans/analytics/aggregate:
3371933984
post:
3372033985
description: 'The API endpoint to aggregate spans into buckets and compute metrics
@@ -36129,6 +36394,18 @@ tags:
3612936394
externalDocs:
3613036395
url: https://docs.datadoghq.com/tracing/service_catalog/
3613136396
name: Service Definition
36397+
- description: '[Service Level Objectives](https://docs.datadoghq.com/monitors/service_level_objectives/#configuration)
36398+
36399+
(SLOs) are a key part of the site reliability engineering toolkit.
36400+
36401+
SLOs provide a framework for defining clear targets around application performance,
36402+
36403+
which ultimately help teams provide a consistent customer experience,
36404+
36405+
balance feature development with platform stability,
36406+
36407+
and improve communication with internal and external users.'
36408+
name: Service Level Objectives
3613236409
- description: 'API to create, update scorecard rules and outcomes. See [Service Scorecards](https://docs.datadoghq.com/service_catalog/scorecards)
3613336410
for more information.
3613436411

Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
"2024-04-04T17:43:19.757Z"

0 commit comments

Comments
 (0)