Skip to content

Commit aee6320

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 0f78b75 of spec repo
1 parent b323d97 commit aee6320

25 files changed

Lines changed: 232 additions & 126 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 56 additions & 48 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 type
17465+
field is provided.
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 id field
17473+
is provided.
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.
@@ -76477,7 +76477,9 @@ paths:
7647776477

7647876478
- Change Lead Time
7647976479

76480-
- Change Failure Rate'
76480+
- Change Failure Rate
76481+
76482+
- Failed Deployment Recovery Time'
7648176483
operationId: CreateDORADeployment
7648276484
requestBody:
7648376485
content:
@@ -76626,7 +76628,13 @@ paths:
7662676628
permissions:
7662776629
- dora_metrics_read
7662876630
patch:
76629-
description: Use this API endpoint to patch a deployment event.
76631+
description: 'Update a deployment''s change failure status. Use this to mark
76632+
a deployment as a change
76633+
76634+
failure or back to stable. You can optionally include remediation details
76635+
to enable
76636+
76637+
failed deployment recovery time calculation.'
7663076638
operationId: PatchDORADeployment
7663176639
parameters:
7663276640
- description: The ID of the deployment event.
@@ -76667,14 +76675,18 @@ paths:
7666776675
- dora_metrics_write
7666876676
/api/v2/dora/failure:
7666976677
post:
76670-
description: 'Use this API endpoint to provide failure data.
76678+
description: 'Use this API endpoint to provide incident data for DORA Metrics.
7667176679

76680+
Note that change failure rate and failed deployment recovery time are computed
76681+
from
7667276682

76673-
This is necessary for:
76683+
change failures detected on deployments,
7667476684

76675-
- Change Failure Rate
76685+
not from incident events sent through this endpoint.
7667676686

76677-
- Time to Restore'
76687+
Tracking incidents gives a side-by-side view of how failed deployments translate
76688+
76689+
into real-world incidents, including their severity and frequency.'
7667876690
operationId: CreateDORAFailure
7667976691
requestBody:
7668076692
content:
@@ -76707,16 +76719,16 @@ paths:
7670776719
$ref: '#/components/responses/TooManyRequestsResponse'
7670876720
security:
7670976721
- apiKeyAuth: []
76710-
summary: Send a failure event
76722+
summary: Send an incident event
7671176723
tags:
7671276724
- DORA Metrics
7671376725
x-codegen-request-body-name: body
7671476726
/api/v2/dora/failure/{failure_id}:
7671576727
delete:
76716-
description: Use this API endpoint to delete a failure event.
76728+
description: Use this API endpoint to delete an incident event.
7671776729
operationId: DeleteDORAFailure
7671876730
parameters:
76719-
- description: The ID of the failure event to delete.
76731+
- description: The ID of the incident event to delete.
7672076732
in: path
7672176733
name: failure_id
7672276734
required: true
@@ -76738,7 +76750,7 @@ paths:
7673876750
security:
7673976751
- apiKeyAuth: []
7674076752
appKeyAuth: []
76741-
summary: Delete a failure event
76753+
summary: Delete an incident event
7674276754
tags:
7674376755
- DORA Metrics
7674476756
x-permission:
@@ -76747,7 +76759,7 @@ paths:
7674776759
- dora_metrics_write
7674876760
/api/v2/dora/failures:
7674976761
post:
76750-
description: Use this API endpoint to get a list of failure events.
76762+
description: Use this API endpoint to get a list of incident events.
7675176763
operationId: ListDORAFailures
7675276764
requestBody:
7675376765
content:
@@ -76775,7 +76787,7 @@ paths:
7677576787
security:
7677676788
- apiKeyAuth: []
7677776789
appKeyAuth: []
76778-
summary: Get a list of failure events
76790+
summary: Get a list of incident events
7677976791
tags:
7678076792
- DORA Metrics
7678176793
x-codegen-request-body-name: body
@@ -76785,10 +76797,10 @@ paths:
7678576797
- dora_metrics_read
7678676798
/api/v2/dora/failures/{failure_id}:
7678776799
get:
76788-
description: Use this API endpoint to get a failure event.
76800+
description: Use this API endpoint to get an incident event.
7678976801
operationId: GetDORAFailure
7679076802
parameters:
76791-
- description: The ID of the failure event.
76803+
- description: The ID of the incident event.
7679276804
in: path
7679376805
name: failure_id
7679476806
required: true
@@ -76814,7 +76826,7 @@ paths:
7681476826
security:
7681576827
- apiKeyAuth: []
7681676828
appKeyAuth: []
76817-
summary: Get a failure event
76829+
summary: Get an incident event
7681876830
tags:
7681976831
- DORA Metrics
7682076832
x-codegen-request-body-name: body
@@ -76829,14 +76841,10 @@ paths:
7682976841
instead.
7683076842

7683176843

76832-
Use this API endpoint to provide failure data.
76833-
76844+
Use this API endpoint to provide incident data.
7683476845

76835-
This is necessary for:
76836-
76837-
- Change Failure Rate
76838-
76839-
- Time to Restore'
76846+
Tracking incidents gives a side-by-side view of how failed deployments translate
76847+
into real-world incidents.'
7684076848
operationId: CreateDORAIncident
7684176849
requestBody:
7684276850
content:
@@ -76869,7 +76877,7 @@ paths:
7686976877
$ref: '#/components/responses/TooManyRequestsResponse'
7687076878
security:
7687176879
- apiKeyAuth: []
76872-
summary: Send an incident event
76880+
summary: Send an incident event (legacy)
7687376881
tags:
7687476882
- DORA Metrics
7687576883
x-codegen-request-body-name: body

examples/v2/dora-metrics/CreateDORAFailure.ts

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
import { client, v2 } from "@datadog/datadog-api-client";

examples/v2/dora-metrics/CreateDORAIncident.ts

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
import { client, v2 } from "@datadog/datadog-api-client";

examples/v2/dora-metrics/DeleteDORAFailure.ts

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
import { client, v2 } from "@datadog/datadog-api-client";
@@ -8,7 +8,7 @@ const configuration = client.createConfiguration();
88
const apiInstance = new v2.DORAMetricsApi(configuration);
99

1010
const params: v2.DORAMetricsApiDeleteDORAFailureRequest = {
11-
failureId: "NO_VALUE",
11+
failureId: "failure_id",
1212
};
1313

1414
apiInstance
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/**
2+
* Delete a failure event returns "Accepted" response
3+
*/
4+
5+
import { client, v2 } from "@datadog/datadog-api-client";
6+
7+
const configuration = client.createConfiguration();
8+
const apiInstance = new v2.DORAMetricsApi(configuration);
9+
10+
const params: v2.DORAMetricsApiDeleteDORAFailureRequest = {
11+
failureId: "NO_VALUE",
12+
};
13+
14+
apiInstance
15+
.deleteDORAFailure(params)
16+
.then((data: any) => {
17+
console.log(
18+
"API called successfully. Returned data: " + JSON.stringify(data)
19+
);
20+
})
21+
.catch((error: any) => console.error(error));

examples/v2/dora-metrics/GetDORAFailure.ts

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
import { client, v2 } from "@datadog/datadog-api-client";

examples/v2/dora-metrics/ListDORAFailures.ts

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
import { client, v2 } from "@datadog/datadog-api-client";
@@ -11,9 +11,11 @@ const params: v2.DORAMetricsApiListDORAFailuresRequest = {
1111
body: {
1212
data: {
1313
attributes: {
14-
from: new Date(2025, 3, 23, 0, 0, 0, 0),
15-
limit: 1,
16-
to: new Date(2025, 3, 24, 0, 0, 0, 0),
14+
from: new Date(2025, 1, 1, 0, 0, 0, 0),
15+
limit: 100,
16+
query: "severity:(SEV-1 OR SEV-2) env:production team:backend",
17+
sort: "-started_at",
18+
to: new Date(2025, 1, 31, 23, 59, 59, 0),
1719
},
1820
type: "dora_failures_list_request",
1921
},

0 commit comments

Comments
 (0)