Skip to content

Commit 4c78049

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit ea5efd73 of spec repo
1 parent 8b59579 commit 4c78049

34 files changed

+1298
-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-03-22 19:28:37.393039",
8-
"spec_repo_commit": "b8f385dc"
7+
"regenerated": "2024-03-25 22:08:35.637644",
8+
"spec_repo_commit": "ea5efd73"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-03-22 19:28:37.408645",
13-
"spec_repo_commit": "b8f385dc"
12+
"regenerated": "2024-03-25 22:08:35.654377",
13+
"spec_repo_commit": "ea5efd73"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 276 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`.'
@@ -16487,6 +16494,92 @@ components:
1648716494
type: string
1648816495
x-enum-varnames:
1648916496
- SAML_ASSERTION_ATTRIBUTES
16497+
SLOReportInterval:
16498+
description: The frequency at which report data is to be generated.
16499+
enum:
16500+
- weekly
16501+
- monthly
16502+
example: weekly
16503+
type: string
16504+
x-enum-varnames:
16505+
- WEEKLY
16506+
- MONTHLY
16507+
SLOReportPostRequest:
16508+
description: The SLO report request body.
16509+
properties:
16510+
data:
16511+
$ref: '#/components/schemas/SLOReportPostRequestData'
16512+
required:
16513+
- data
16514+
type: object
16515+
SLOReportPostRequestData:
16516+
description: The data portion of the SLO report request.
16517+
properties:
16518+
attributes:
16519+
$ref: '#/components/schemas/SloReportPostRequestAttributes'
16520+
required:
16521+
- attributes
16522+
type: object
16523+
SLOReportPostResponse:
16524+
description: The SLO report response.
16525+
properties:
16526+
data:
16527+
$ref: '#/components/schemas/SLOReportPostResponseData'
16528+
type: object
16529+
SLOReportPostResponseData:
16530+
description: The data portion of the SLO report response.
16531+
properties:
16532+
id:
16533+
description: The ID of the report job.
16534+
example: dc8d92aa-e0af-11ee-af21-1feeaccaa3a3
16535+
type: string
16536+
type:
16537+
description: The type of ID.
16538+
example: report_id
16539+
type: string
16540+
type: object
16541+
SLOReportStatus:
16542+
description: The status of the SLO report job.
16543+
enum:
16544+
- IN_PROGRESS
16545+
- COMPLETED
16546+
- COMPLETED_WITH_ERRORS
16547+
- FAILED
16548+
- UNKNOWN
16549+
example: COMPLETED
16550+
type: string
16551+
x-enum-varnames:
16552+
- IN_PROGRESS
16553+
- COMPLETED
16554+
- COMPLETED_WITH_ERRORS
16555+
- FAILED
16556+
- UNKNOWN
16557+
SLOReportStatusGetResponse:
16558+
description: The SLO report status response.
16559+
properties:
16560+
data:
16561+
$ref: '#/components/schemas/SLOReportStatusGetResponseData'
16562+
type: object
16563+
SLOReportStatusGetResponseAttributes:
16564+
description: The attributes portion of the SLO report status response.
16565+
properties:
16566+
status:
16567+
$ref: '#/components/schemas/SLOReportStatus'
16568+
type: object
16569+
SLOReportStatusGetResponseData:
16570+
description: The data portion of the SLO report status response.
16571+
properties:
16572+
attributes:
16573+
$ref: '#/components/schemas/SLOReportStatusGetResponseAttributes'
16574+
id:
16575+
description: The ID of the report job.
16576+
example: dc8d92aa-e0af-11ee-af21-1feeaccaa3a3
16577+
type: string
16578+
type:
16579+
description: The type of ID.
16580+
example: report_id
16581+
type: string
16582+
type: object
1649016583
ScalarColumn:
1649116584
description: A single column in a scalar query response.
1649216585
oneOf:
@@ -20124,6 +20217,37 @@ components:
2012420217
- channel_name
2012520218
- redirect_url
2012620219
type: object
20220+
SloReportPostRequestAttributes:
20221+
description: The attributes portion of the SLO report request.
20222+
properties:
20223+
from_ts:
20224+
description: The `from` timestamp for the report in epoch seconds.
20225+
example: 1690901870
20226+
format: int64
20227+
type: integer
20228+
interval:
20229+
$ref: '#/components/schemas/SLOReportInterval'
20230+
query:
20231+
description: The query string used to filter SLO results. Some examples
20232+
of queries include `service:<service-name>` and `slo-name`.
20233+
example: slo_type:metric
20234+
type: string
20235+
timezone:
20236+
description: The timezone used to determine the start and end of each interval.
20237+
For example, weekly intervals start at 12am on Sunday in the specified
20238+
timezone.
20239+
example: America/New_York
20240+
type: string
20241+
to_ts:
20242+
description: The `to` timestamp for the report in epoch seconds.
20243+
example: 1706803070
20244+
format: int64
20245+
type: integer
20246+
required:
20247+
- query
20248+
- from_ts
20249+
- to_ts
20250+
type: object
2012720251
SortDirection:
2012820252
default: desc
2012920253
description: The direction to sort by.
@@ -33594,6 +33718,146 @@ paths:
3359433718
- Incident Services
3359533719
x-codegen-request-body-name: body
3359633720
x-unstable: '**Note**: This endpoint is deprecated.'
33721+
/api/v2/slo/report:
33722+
post:
33723+
description: 'Create a job to generate an SLO report. The report job is processed
33724+
asynchronously and will eventually result in a CSV report being available
33725+
for download.
33726+
33727+
33728+
Check the status of the job and download the CSV report using the returned
33729+
`report_id`.'
33730+
operationId: CreateSLOReportJob
33731+
requestBody:
33732+
content:
33733+
application/json:
33734+
schema:
33735+
$ref: '#/components/schemas/SLOReportPostRequest'
33736+
description: Create SLO report job request body.
33737+
required: true
33738+
responses:
33739+
'200':
33740+
content:
33741+
application/json:
33742+
schema:
33743+
$ref: '#/components/schemas/SLOReportPostResponse'
33744+
description: OK
33745+
'400':
33746+
content:
33747+
application/json:
33748+
schema:
33749+
$ref: '#/components/schemas/APIErrorResponse'
33750+
description: Bad Request
33751+
'403':
33752+
content:
33753+
application/json:
33754+
schema:
33755+
$ref: '#/components/schemas/APIErrorResponse'
33756+
description: Forbidden
33757+
'429':
33758+
$ref: '#/components/responses/TooManyRequestsResponse'
33759+
security:
33760+
- apiKeyAuth: []
33761+
appKeyAuth: []
33762+
- AuthZ:
33763+
- slos_read
33764+
summary: Create a new SLO report
33765+
tags:
33766+
- Service Level Objectives
33767+
x-codegen-request-body-name: body
33768+
x-unstable: '**Note: This feature is in private beta. If you are interested
33769+
in joining,
33770+
33771+
request access via [our public docs](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export).**'
33772+
/api/v2/slo/report/{report_id}/download:
33773+
get:
33774+
description: 'Download an SLO report. This can only be performed after the report
33775+
job has completed.
33776+
33777+
33778+
Reports are not guaranteed to exist indefinitely. It is recommended to download
33779+
the report as soon as it is available.'
33780+
operationId: GetSLOReport
33781+
parameters:
33782+
- $ref: '#/components/parameters/ReportID'
33783+
responses:
33784+
'200':
33785+
content:
33786+
text/csv:
33787+
schema:
33788+
type: string
33789+
description: OK
33790+
'403':
33791+
content:
33792+
application/json:
33793+
schema:
33794+
$ref: '#/components/schemas/APIErrorResponse'
33795+
description: Forbidden
33796+
'404':
33797+
content:
33798+
application/json:
33799+
schema:
33800+
$ref: '#/components/schemas/APIErrorResponse'
33801+
description: Not Found
33802+
'429':
33803+
$ref: '#/components/responses/TooManyRequestsResponse'
33804+
security:
33805+
- apiKeyAuth: []
33806+
appKeyAuth: []
33807+
- AuthZ:
33808+
- slos_read
33809+
summary: Get SLO report
33810+
tags:
33811+
- Service Level Objectives
33812+
x-unstable: '**Note: This feature is in private beta. If you are interested
33813+
in joining,
33814+
33815+
request access via [our public docs](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export).**'
33816+
/api/v2/slo/report/{report_id}/status:
33817+
get:
33818+
description: Get the status of the SLO report job.
33819+
operationId: GetSLOReportJobStatus
33820+
parameters:
33821+
- $ref: '#/components/parameters/ReportID'
33822+
responses:
33823+
'200':
33824+
content:
33825+
application/json:
33826+
schema:
33827+
$ref: '#/components/schemas/SLOReportStatusGetResponse'
33828+
description: OK
33829+
'400':
33830+
content:
33831+
application/json:
33832+
schema:
33833+
$ref: '#/components/schemas/APIErrorResponse'
33834+
description: Bad Request
33835+
'403':
33836+
content:
33837+
application/json:
33838+
schema:
33839+
$ref: '#/components/schemas/APIErrorResponse'
33840+
description: Forbidden
33841+
'404':
33842+
content:
33843+
application/json:
33844+
schema:
33845+
$ref: '#/components/schemas/APIErrorResponse'
33846+
description: Not Found
33847+
'429':
33848+
$ref: '#/components/responses/TooManyRequestsResponse'
33849+
security:
33850+
- apiKeyAuth: []
33851+
appKeyAuth: []
33852+
- AuthZ:
33853+
- slos_read
33854+
summary: Get SLO report status
33855+
tags:
33856+
- Service Level Objectives
33857+
x-unstable: '**Note: This feature is in private beta. If you are interested
33858+
in joining,
33859+
33860+
request access via [our public docs](https://docs.datadoghq.com/service_management/service_level_objectives/#slo-csv-export).**'
3359733861
/api/v2/spans/analytics/aggregate:
3359833862
post:
3359933863
description: 'The API endpoint to aggregate spans into buckets and compute metrics
@@ -36005,6 +36269,18 @@ tags:
3600536269
externalDocs:
3600636270
url: https://docs.datadoghq.com/tracing/service_catalog/
3600736271
name: Service Definition
36272+
- description: '[Service Level Objectives](https://docs.datadoghq.com/monitors/service_level_objectives/#configuration)
36273+
36274+
(or SLOs) are a key part of the site reliability engineering toolkit.
36275+
36276+
SLOs provide a framework for defining clear targets around application performance,
36277+
36278+
which ultimately help teams provide a consistent customer experience,
36279+
36280+
balance feature development with platform stability,
36281+
36282+
and improve communication with internal and external users.'
36283+
name: Service Level Objectives
3600836284
- description: 'API to create, update scorecard rules and outcomes. See [Service Scorecards](https://docs.datadoghq.com/service_catalog/scorecards)
3600936285
for more information.
3601036286

docs/datadog_api_client.v2.api.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -295,6 +295,13 @@ service\_definition\_api
295295
:members:
296296
:show-inheritance:
297297

298+
service\_level\_objectives\_api
299+
-------------------------------
300+
301+
.. automodule:: datadog_api_client.v2.api.service_level_objectives_api
302+
:members:
303+
:show-inheritance:
304+
298305
service\_scorecards\_api
299306
------------------------
300307

0 commit comments

Comments
 (0)