Skip to content

Commit 631e3bf

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 4c618af of spec repo
1 parent 926ff5f commit 631e3bf

25 files changed

+231
-138
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -17457,20 +17457,20 @@ components:
1745717457
- finished_at
1745817458
type: object
1745917459
DORADeploymentPatchRemediation:
17460-
description: Remediation details for the deployment.
17460+
description: Remediation details for the deployment. Optional, but required
17461+
to calculate failed deployment recovery time.
1746117462
properties:
1746217463
id:
17463-
description: The ID of the remediation action.
17464+
description: The ID of the remediation deployment. Required when the failed
17465+
deployment must be linked to a remediation deployment.
1746417466
example: eG42zNIkVjM
1746517467
type: string
1746617468
type:
1746717469
$ref: '#/components/schemas/DORADeploymentPatchRemediationType'
17468-
required:
17469-
- id
17470-
- type
1747117470
type: object
1747217471
DORADeploymentPatchRemediationType:
17473-
description: The type of remediation action taken.
17472+
description: The type of remediation action taken. Required when the failed
17473+
deployment must be linked to a remediation deployment.
1747417474
enum:
1747517475
- rollback
1747617476
- rollforward
@@ -17674,47 +17674,47 @@ components:
1767417674
type: array
1767517675
type: object
1767617676
DORAFailureFetchResponse:
17677-
description: Response for fetching a single failure event.
17677+
description: Response for fetching a single incident event.
1767817678
properties:
1767917679
data:
1768017680
$ref: '#/components/schemas/DORAIncidentObject'
1768117681
type: object
1768217682
DORAFailureRequest:
17683-
description: Request to create a DORA failure event.
17683+
description: Request to create a DORA incident event.
1768417684
properties:
1768517685
data:
1768617686
$ref: '#/components/schemas/DORAFailureRequestData'
1768717687
required:
1768817688
- data
1768917689
type: object
1769017690
DORAFailureRequestAttributes:
17691-
description: Attributes to create a DORA failure event.
17691+
description: Attributes to create a DORA incident event.
1769217692
properties:
1769317693
custom_tags:
1769417694
$ref: '#/components/schemas/DORACustomTags'
1769517695
env:
17696-
description: Environment name that was impacted by the failure.
17696+
description: Environment name that was impacted by the incident.
1769717697
example: staging
1769817698
type: string
1769917699
finished_at:
17700-
description: Unix timestamp when the failure finished. It must be in nanoseconds,
17700+
description: Unix timestamp when the incident finished. It must be in nanoseconds,
1770117701
milliseconds, or seconds.
1770217702
example: 1693491984000000000
1770317703
format: int64
1770417704
type: integer
1770517705
git:
1770617706
$ref: '#/components/schemas/DORAGitInfo'
1770717707
id:
17708-
description: Failure ID. Must be 16-128 characters and contain only alphanumeric
17708+
description: Incident ID. Must be 16-128 characters and contain only alphanumeric
1770917709
characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9,
1771017710
-, _, ., :).
1771117711
type: string
1771217712
name:
17713-
description: Failure name.
17713+
description: Incident name.
1771417714
example: Webserver is down failing all requests.
1771517715
type: string
1771617716
services:
17717-
description: Service names impacted by the failure. If possible, use names
17717+
description: Service names impacted by the incident. If possible, use names
1771817718
registered in the Service Catalog. Required when the team field is not
1771917719
provided.
1772017720
example:
@@ -17723,11 +17723,11 @@ components:
1772317723
type: string
1772417724
type: array
1772517725
severity:
17726-
description: Failure severity.
17726+
description: Incident severity.
1772717727
example: High
1772817728
type: string
1772917729
started_at:
17730-
description: Unix timestamp when the failure started. It must be in nanoseconds,
17730+
description: Unix timestamp when the incident started. It must be in nanoseconds,
1773117731
milliseconds, or seconds.
1773217732
example: 1693491974000000000
1773317733
format: int64
@@ -17754,18 +17754,18 @@ components:
1775417754
- attributes
1775517755
type: object
1775617756
DORAFailureResponse:
17757-
description: Response after receiving a DORA failure event.
17757+
description: Response after receiving a DORA incident event.
1775817758
properties:
1775917759
data:
1776017760
$ref: '#/components/schemas/DORAFailureResponseData'
1776117761
required:
1776217762
- data
1776317763
type: object
1776417764
DORAFailureResponseData:
17765-
description: Response after receiving a DORA failure event.
17765+
description: Response after receiving a DORA incident event.
1776617766
properties:
1776717767
id:
17768-
description: The ID of the received DORA failure event.
17768+
description: The ID of the received DORA incident event.
1776917769
example: 4242fcdd31586083
1777017770
type: string
1777117771
type:
@@ -17775,15 +17775,15 @@ components:
1777517775
type: object
1777617776
DORAFailureType:
1777717777
default: dora_failure
17778-
description: JSON:API type for DORA failure events.
17778+
description: JSON:API type for DORA incident events.
1777917779
enum:
1778017780
- dora_failure
1778117781
example: dora_failure
1778217782
type: string
1778317783
x-enum-varnames:
1778417784
- DORA_FAILURE
1778517785
DORAFailuresListResponse:
17786-
description: Response for the list failures endpoint.
17786+
description: Response for the list incidents endpoint.
1778717787
example:
1778817788
data:
1778917789
- attributes:
@@ -17917,7 +17917,7 @@ components:
1791717917
from: '2025-01-01T00:00:00Z'
1791817918
limit: 100
1791917919
query: service:(shopist OR api-service) env:production team:backend
17920-
sort: -started_at
17920+
sort: -finished_at
1792117921
to: '2025-01-31T23:59:59Z'
1792217922
type: dora_deployments_list_request
1792317923
properties:
@@ -17948,7 +17948,7 @@ components:
1794817948
type: string
1794917949
sort:
1795017950
description: Sort order (prefixed with `-` for descending).
17951-
example: -started_at
17951+
example: -finished_at
1795217952
type: string
1795317953
to:
1795417954
description: Maximum timestamp for requested events.
@@ -17984,7 +17984,7 @@ components:
1798417984
x-enum-varnames:
1798517985
- DORA_DEPLOYMENTS_LIST_REQUEST
1798617986
DORAListFailuresRequest:
17987-
description: Request to get a list of failures.
17987+
description: Request to get a list of incidents.
1798817988
example:
1798917989
data:
1799017990
attributes:
@@ -18001,7 +18001,7 @@ components:
1800118001
- data
1800218002
type: object
1800318003
DORAListFailuresRequestAttributes:
18004-
description: Attributes to get a list of failures.
18004+
description: Attributes to get a list of incidents.
1800518005
properties:
1800618006
from:
1800718007
description: Minimum timestamp for requested events.
@@ -77043,7 +77043,9 @@ paths:
7704377043

7704477044
- Change Lead Time
7704577045

77046-
- Change Failure Rate'
77046+
- Change Failure Rate
77047+
77048+
- Failed Deployment Recovery Time'
7704777049
operationId: CreateDORADeployment
7704877050
requestBody:
7704977051
content:
@@ -77192,7 +77194,9 @@ paths:
7719277194
permissions:
7719377195
- dora_metrics_read
7719477196
patch:
77195-
description: Use this API endpoint to patch a deployment event.
77197+
description: Update a deployment's change failure status. Use this to mark a
77198+
deployment as a change failure or back to stable. You can optionally include
77199+
remediation details to enable failed deployment recovery time calculation.
7719677200
operationId: PatchDORADeployment
7719777201
parameters:
7719877202
- description: The ID of the deployment event.
@@ -77233,14 +77237,14 @@ paths:
7723377237
- dora_metrics_write
7723477238
/api/v2/dora/failure:
7723577239
post:
77236-
description: 'Use this API endpoint to provide failure data.
77240+
description: 'Use this API endpoint to provide incident data for DORA Metrics.
7723777241

77242+
Note that change failure rate and failed deployment recovery time are computed
77243+
from change failures detected on deployments, not from incident events sent
77244+
through this endpoint.
7723877245

77239-
This is necessary for:
77240-
77241-
- Change Failure Rate
77242-
77243-
- Time to Restore'
77246+
Tracking incidents gives a side-by-side view of how failed deployments translate
77247+
into real-world incidents, including their severity and frequency.'
7724477248
operationId: CreateDORAFailure
7724577249
requestBody:
7724677250
content:
@@ -77273,16 +77277,16 @@ paths:
7727377277
$ref: '#/components/responses/TooManyRequestsResponse'
7727477278
security:
7727577279
- apiKeyAuth: []
77276-
summary: Send a failure event
77280+
summary: Send an incident event
7727777281
tags:
7727877282
- DORA Metrics
7727977283
x-codegen-request-body-name: body
7728077284
/api/v2/dora/failure/{failure_id}:
7728177285
delete:
77282-
description: Use this API endpoint to delete a failure event.
77286+
description: Use this API endpoint to delete an incident event.
7728377287
operationId: DeleteDORAFailure
7728477288
parameters:
77285-
- description: The ID of the failure event to delete.
77289+
- description: The ID of the incident event to delete.
7728677290
in: path
7728777291
name: failure_id
7728877292
required: true
@@ -77304,7 +77308,7 @@ paths:
7730477308
security:
7730577309
- apiKeyAuth: []
7730677310
appKeyAuth: []
77307-
summary: Delete a failure event
77311+
summary: Delete an incident event
7730877312
tags:
7730977313
- DORA Metrics
7731077314
x-permission:
@@ -77313,7 +77317,7 @@ paths:
7731377317
- dora_metrics_write
7731477318
/api/v2/dora/failures:
7731577319
post:
77316-
description: Use this API endpoint to get a list of failure events.
77320+
description: Use this API endpoint to get a list of incident events.
7731777321
operationId: ListDORAFailures
7731877322
requestBody:
7731977323
content:
@@ -77341,7 +77345,7 @@ paths:
7734177345
security:
7734277346
- apiKeyAuth: []
7734377347
appKeyAuth: []
77344-
summary: Get a list of failure events
77348+
summary: Get a list of incident events
7734577349
tags:
7734677350
- DORA Metrics
7734777351
x-codegen-request-body-name: body
@@ -77351,10 +77355,10 @@ paths:
7735177355
- dora_metrics_read
7735277356
/api/v2/dora/failures/{failure_id}:
7735377357
get:
77354-
description: Use this API endpoint to get a failure event.
77358+
description: Use this API endpoint to get an incident event.
7735577359
operationId: GetDORAFailure
7735677360
parameters:
77357-
- description: The ID of the failure event.
77361+
- description: The ID of the incident event.
7735877362
in: path
7735977363
name: failure_id
7736077364
required: true
@@ -77380,7 +77384,7 @@ paths:
7738077384
security:
7738177385
- apiKeyAuth: []
7738277386
appKeyAuth: []
77383-
summary: Get a failure event
77387+
summary: Get an incident event
7738477388
tags:
7738577389
- DORA Metrics
7738677390
x-codegen-request-body-name: body
@@ -77395,14 +77399,10 @@ paths:
7739577399
instead.
7739677400

7739777401

77398-
Use this API endpoint to provide failure data.
77399-
77402+
Use this API endpoint to provide incident data.
7740077403

77401-
This is necessary for:
77402-
77403-
- Change Failure Rate
77404-
77405-
- Time to Restore'
77404+
Tracking incidents gives a side-by-side view of how failed deployments translate
77405+
into real-world incidents.'
7740677406
operationId: CreateDORAIncident
7740777407
requestBody:
7740877408
content:
@@ -77435,7 +77435,7 @@ paths:
7743577435
$ref: '#/components/responses/TooManyRequestsResponse'
7743677436
security:
7743777437
- apiKeyAuth: []
77438-
summary: Send an incident event
77438+
summary: Send an incident event (legacy)
7743977439
tags:
7744077440
- DORA Metrics
7744177441
x-codegen-request-body-name: body

examples/v2/dora-metrics/CreateDORAFailure.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Send a failure event returns "OK - but delayed due to incident" response
2+
Send an incident event returns "OK" response
33
"""
44

55
from datadog_api_client import ApiClient, Configuration

examples/v2/dora-metrics/CreateDORAIncident.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Send an incident event returns "OK" response
2+
Send an incident event (legacy) returns "OK" response
33
"""
44

55
from datadog_api_client import ApiClient, Configuration
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Delete a failure event returns "Accepted" response
2+
Delete an incident event returns "Accepted" response
33
"""
44

55
from datadog_api_client import ApiClient, Configuration
@@ -9,5 +9,5 @@
99
with ApiClient(configuration) as api_client:
1010
api_instance = DORAMetricsApi(api_client)
1111
api_instance.delete_dora_failure(
12-
failure_id="NO_VALUE",
12+
failure_id="failure_id",
1313
)
Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
"""
2+
Delete a failure event returns "Accepted" response
3+
"""
4+
5+
from datadog_api_client import ApiClient, Configuration
6+
from datadog_api_client.v2.api.dora_metrics_api import DORAMetricsApi
7+
8+
configuration = Configuration()
9+
with ApiClient(configuration) as api_client:
10+
api_instance = DORAMetricsApi(api_client)
11+
api_instance.delete_dora_failure(
12+
failure_id="NO_VALUE",
13+
)

examples/v2/dora-metrics/GetDORAFailure.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Get a failure event returns "OK" response
2+
Get an incident event returns "OK" response
33
"""
44

55
from datadog_api_client import ApiClient, Configuration

examples/v2/dora-metrics/ListDORAFailures.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Get a list of failure events returns "OK" response
2+
Get a list of incident events returns "OK" response
33
"""
44

55
from datadog_api_client import ApiClient, Configuration
@@ -14,9 +14,11 @@
1414
body = DORAListFailuresRequest(
1515
data=DORAListFailuresRequestData(
1616
attributes=DORAListFailuresRequestAttributes(
17-
_from=datetime(2025, 3, 23, 0, 0, tzinfo=tzutc()),
18-
limit=1,
19-
to=datetime(2025, 3, 24, 0, 0, tzinfo=tzutc()),
17+
_from=datetime(2025, 1, 1, 0, 0, tzinfo=tzutc()),
18+
limit=100,
19+
query="severity:(SEV-1 OR SEV-2) env:production team:backend",
20+
sort="-started_at",
21+
to=datetime(2025, 1, 31, 23, 59, 59, tzinfo=tzutc()),
2022
),
2123
type=DORAListFailuresRequestDataType.DORA_FAILURES_LIST_REQUEST,
2224
),

0 commit comments

Comments
 (0)