Skip to content

Commit 2d7bf90

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 2c64a11 of spec repo
1 parent 865f960 commit 2d7bf90

25 files changed

+269
-157
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 50 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -18430,20 +18430,20 @@ components:
1843018430
- finished_at
1843118431
type: object
1843218432
DORADeploymentPatchRemediation:
18433-
description: Remediation details for the deployment.
18433+
description: Remediation details for the deployment. Optional, but required
18434+
to calculate failed deployment recovery time.
1843418435
properties:
1843518436
id:
18436-
description: The ID of the remediation action.
18437+
description: The ID of the remediation deployment. Required when the failed
18438+
deployment must be linked to a remediation deployment.
1843718439
example: eG42zNIkVjM
1843818440
type: string
1843918441
type:
1844018442
$ref: '#/components/schemas/DORADeploymentPatchRemediationType'
18441-
required:
18442-
- id
18443-
- type
1844418443
type: object
1844518444
DORADeploymentPatchRemediationType:
18446-
description: The type of remediation action taken.
18445+
description: The type of remediation action taken. Required when the failed
18446+
deployment must be linked to a remediation deployment.
1844718447
enum:
1844818448
- rollback
1844918449
- rollforward
@@ -18647,47 +18647,47 @@ components:
1864718647
type: array
1864818648
type: object
1864918649
DORAFailureFetchResponse:
18650-
description: Response for fetching a single failure event.
18650+
description: Response for fetching a single incident event.
1865118651
properties:
1865218652
data:
1865318653
$ref: '#/components/schemas/DORAIncidentObject'
1865418654
type: object
1865518655
DORAFailureRequest:
18656-
description: Request to create a DORA failure event.
18656+
description: Request to create a DORA incident event.
1865718657
properties:
1865818658
data:
1865918659
$ref: '#/components/schemas/DORAFailureRequestData'
1866018660
required:
1866118661
- data
1866218662
type: object
1866318663
DORAFailureRequestAttributes:
18664-
description: Attributes to create a DORA failure event.
18664+
description: Attributes to create a DORA incident event.
1866518665
properties:
1866618666
custom_tags:
1866718667
$ref: '#/components/schemas/DORACustomTags'
1866818668
env:
18669-
description: Environment name that was impacted by the failure.
18669+
description: Environment name that was impacted by the incident.
1867018670
example: staging
1867118671
type: string
1867218672
finished_at:
18673-
description: Unix timestamp when the failure finished. It must be in nanoseconds,
18673+
description: Unix timestamp when the incident finished. It must be in nanoseconds,
1867418674
milliseconds, or seconds.
1867518675
example: 1693491984000000000
1867618676
format: int64
1867718677
type: integer
1867818678
git:
1867918679
$ref: '#/components/schemas/DORAGitInfo'
1868018680
id:
18681-
description: Failure ID. Must be 16-128 characters and contain only alphanumeric
18681+
description: Incident ID. Must be 16-128 characters and contain only alphanumeric
1868218682
characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9,
1868318683
-, _, ., :).
1868418684
type: string
1868518685
name:
18686-
description: Failure name.
18686+
description: Incident name.
1868718687
example: Webserver is down failing all requests.
1868818688
type: string
1868918689
services:
18690-
description: Service names impacted by the failure. If possible, use names
18690+
description: Service names impacted by the incident. If possible, use names
1869118691
registered in the Service Catalog. Required when the team field is not
1869218692
provided.
1869318693
example:
@@ -18696,11 +18696,11 @@ components:
1869618696
type: string
1869718697
type: array
1869818698
severity:
18699-
description: Failure severity.
18699+
description: Incident severity.
1870018700
example: High
1870118701
type: string
1870218702
started_at:
18703-
description: Unix timestamp when the failure started. It must be in nanoseconds,
18703+
description: Unix timestamp when the incident started. It must be in nanoseconds,
1870418704
milliseconds, or seconds.
1870518705
example: 1693491974000000000
1870618706
format: int64
@@ -18727,18 +18727,18 @@ components:
1872718727
- attributes
1872818728
type: object
1872918729
DORAFailureResponse:
18730-
description: Response after receiving a DORA failure event.
18730+
description: Response after receiving a DORA incident event.
1873118731
properties:
1873218732
data:
1873318733
$ref: '#/components/schemas/DORAFailureResponseData'
1873418734
required:
1873518735
- data
1873618736
type: object
1873718737
DORAFailureResponseData:
18738-
description: Response after receiving a DORA failure event.
18738+
description: Response after receiving a DORA incident event.
1873918739
properties:
1874018740
id:
18741-
description: The ID of the received DORA failure event.
18741+
description: The ID of the received DORA incident event.
1874218742
example: 4242fcdd31586083
1874318743
type: string
1874418744
type:
@@ -18748,15 +18748,15 @@ components:
1874818748
type: object
1874918749
DORAFailureType:
1875018750
default: dora_failure
18751-
description: JSON:API type for DORA failure events.
18751+
description: JSON:API type for DORA incident events.
1875218752
enum:
1875318753
- dora_failure
1875418754
example: dora_failure
1875518755
type: string
1875618756
x-enum-varnames:
1875718757
- DORA_FAILURE
1875818758
DORAFailuresListResponse:
18759-
description: Response for the list failures endpoint.
18759+
description: Response for the list incidents endpoint.
1876018760
example:
1876118761
data:
1876218762
- attributes:
@@ -18890,7 +18890,7 @@ components:
1889018890
from: '2025-01-01T00:00:00Z'
1889118891
limit: 100
1889218892
query: service:(shopist OR api-service) env:production team:backend
18893-
sort: -started_at
18893+
sort: -finished_at
1889418894
to: '2025-01-31T23:59:59Z'
1889518895
type: dora_deployments_list_request
1889618896
properties:
@@ -18921,7 +18921,7 @@ components:
1892118921
type: string
1892218922
sort:
1892318923
description: Sort order (prefixed with `-` for descending).
18924-
example: -started_at
18924+
example: -finished_at
1892518925
type: string
1892618926
to:
1892718927
description: Maximum timestamp for requested events.
@@ -18957,7 +18957,7 @@ components:
1895718957
x-enum-varnames:
1895818958
- DORA_DEPLOYMENTS_LIST_REQUEST
1895918959
DORAListFailuresRequest:
18960-
description: Request to get a list of failures.
18960+
description: Request to get a list of incidents.
1896118961
example:
1896218962
data:
1896318963
attributes:
@@ -18974,7 +18974,7 @@ components:
1897418974
- data
1897518975
type: object
1897618976
DORAListFailuresRequestAttributes:
18977-
description: Attributes to get a list of failures.
18977+
description: Attributes to get a list of incidents.
1897818978
properties:
1897918979
from:
1898018980
description: Minimum timestamp for requested events.
@@ -79427,7 +79427,9 @@ paths:
7942779427

7942879428
- Change Lead Time
7942979429

79430-
- Change Failure Rate'
79430+
- Change Failure Rate
79431+
79432+
- Failed Deployment Recovery Time'
7943179433
operationId: CreateDORADeployment
7943279434
requestBody:
7943379435
content:
@@ -79576,7 +79578,9 @@ paths:
7957679578
permissions:
7957779579
- dora_metrics_read
7957879580
patch:
79579-
description: Use this API endpoint to patch a deployment event.
79581+
description: Update a deployment's change failure status. Use this to mark a
79582+
deployment as a change failure or back to stable. You can optionally include
79583+
remediation details to enable failed deployment recovery time calculation.
7958079584
operationId: PatchDORADeployment
7958179585
parameters:
7958279586
- description: The ID of the deployment event.
@@ -79617,14 +79621,14 @@ paths:
7961779621
- dora_metrics_write
7961879622
/api/v2/dora/failure:
7961979623
post:
79620-
description: 'Use this API endpoint to provide failure data.
79624+
description: 'Use this API endpoint to provide incident data for DORA Metrics.
7962179625

79626+
Note that change failure rate and failed deployment recovery time are computed
79627+
from change failures detected on deployments, not from incident events sent
79628+
through this endpoint.
7962279629

79623-
This is necessary for:
79624-
79625-
- Change Failure Rate
79626-
79627-
- Time to Restore'
79630+
Tracking incidents gives a side-by-side view of how failed deployments translate
79631+
into real-world incidents, including their severity and frequency.'
7962879632
operationId: CreateDORAFailure
7962979633
requestBody:
7963079634
content:
@@ -79657,16 +79661,16 @@ paths:
7965779661
$ref: '#/components/responses/TooManyRequestsResponse'
7965879662
security:
7965979663
- apiKeyAuth: []
79660-
summary: Send a failure event
79664+
summary: Send an incident event
7966179665
tags:
7966279666
- DORA Metrics
7966379667
x-codegen-request-body-name: body
7966479668
/api/v2/dora/failure/{failure_id}:
7966579669
delete:
79666-
description: Use this API endpoint to delete a failure event.
79670+
description: Use this API endpoint to delete an incident event.
7966779671
operationId: DeleteDORAFailure
7966879672
parameters:
79669-
- description: The ID of the failure event to delete.
79673+
- description: The ID of the incident event to delete.
7967079674
in: path
7967179675
name: failure_id
7967279676
required: true
@@ -79688,7 +79692,7 @@ paths:
7968879692
security:
7968979693
- apiKeyAuth: []
7969079694
appKeyAuth: []
79691-
summary: Delete a failure event
79695+
summary: Delete an incident event
7969279696
tags:
7969379697
- DORA Metrics
7969479698
x-permission:
@@ -79697,7 +79701,7 @@ paths:
7969779701
- dora_metrics_write
7969879702
/api/v2/dora/failures:
7969979703
post:
79700-
description: Use this API endpoint to get a list of failure events.
79704+
description: Use this API endpoint to get a list of incident events.
7970179705
operationId: ListDORAFailures
7970279706
requestBody:
7970379707
content:
@@ -79725,7 +79729,7 @@ paths:
7972579729
security:
7972679730
- apiKeyAuth: []
7972779731
appKeyAuth: []
79728-
summary: Get a list of failure events
79732+
summary: Get a list of incident events
7972979733
tags:
7973079734
- DORA Metrics
7973179735
x-codegen-request-body-name: body
@@ -79735,10 +79739,10 @@ paths:
7973579739
- dora_metrics_read
7973679740
/api/v2/dora/failures/{failure_id}:
7973779741
get:
79738-
description: Use this API endpoint to get a failure event.
79742+
description: Use this API endpoint to get an incident event.
7973979743
operationId: GetDORAFailure
7974079744
parameters:
79741-
- description: The ID of the failure event.
79745+
- description: The ID of the incident event.
7974279746
in: path
7974379747
name: failure_id
7974479748
required: true
@@ -79764,7 +79768,7 @@ paths:
7976479768
security:
7976579769
- apiKeyAuth: []
7976679770
appKeyAuth: []
79767-
summary: Get a failure event
79771+
summary: Get an incident event
7976879772
tags:
7976979773
- DORA Metrics
7977079774
x-codegen-request-body-name: body
@@ -79779,14 +79783,10 @@ paths:
7977979783
instead.
7978079784

7978179785

79782-
Use this API endpoint to provide failure data.
79783-
79786+
Use this API endpoint to provide incident data.
7978479787

79785-
This is necessary for:
79786-
79787-
- Change Failure Rate
79788-
79789-
- Time to Restore'
79788+
Tracking incidents gives a side-by-side view of how failed deployments translate
79789+
into real-world incidents.'
7979079790
operationId: CreateDORAIncident
7979179791
requestBody:
7979279792
content:
@@ -79819,7 +79819,7 @@ paths:
7981979819
$ref: '#/components/responses/TooManyRequestsResponse'
7982079820
security:
7982179821
- apiKeyAuth: []
79822-
summary: Send an incident event
79822+
summary: Send an incident event (legacy)
7982379823
tags:
7982479824
- DORA Metrics
7982579825
x-codegen-request-body-name: body

examples/v2/dora-metrics/CreateDORAFailure.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Send a failure event returns "OK - but delayed due to incident" response
1+
// Send an incident event returns "OK" response
22

33
import com.datadog.api.client.ApiClient;
44
import com.datadog.api.client.ApiException;

examples/v2/dora-metrics/CreateDORAIncident.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Send an incident event returns "OK" response
1+
// Send an incident event (legacy) returns "OK" response
22

33
import com.datadog.api.client.ApiClient;
44
import com.datadog.api.client.ApiException;

examples/v2/dora-metrics/DeleteDORAFailure.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Delete a failure event returns "Accepted" response
1+
// Delete an incident event returns "Accepted" response
22

33
import com.datadog.api.client.ApiClient;
44
import com.datadog.api.client.ApiException;
@@ -10,7 +10,7 @@ public static void main(String[] args) {
1010
DoraMetricsApi apiInstance = new DoraMetricsApi(defaultClient);
1111

1212
try {
13-
apiInstance.deleteDORAFailure("NO_VALUE");
13+
apiInstance.deleteDORAFailure("failure_id");
1414
} catch (ApiException e) {
1515
System.err.println("Exception when calling DoraMetricsApi#deleteDORAFailure");
1616
System.err.println("Status code: " + e.getCode());
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Delete a failure event returns "Accepted" response
2+
3+
import com.datadog.api.client.ApiClient;
4+
import com.datadog.api.client.ApiException;
5+
import com.datadog.api.client.v2.api.DoraMetricsApi;
6+
7+
public class Example {
8+
public static void main(String[] args) {
9+
ApiClient defaultClient = ApiClient.getDefaultApiClient();
10+
DoraMetricsApi apiInstance = new DoraMetricsApi(defaultClient);
11+
12+
try {
13+
apiInstance.deleteDORAFailure("NO_VALUE");
14+
} catch (ApiException e) {
15+
System.err.println("Exception when calling DoraMetricsApi#deleteDORAFailure");
16+
System.err.println("Status code: " + e.getCode());
17+
System.err.println("Reason: " + e.getResponseBody());
18+
System.err.println("Response headers: " + e.getResponseHeaders());
19+
e.printStackTrace();
20+
}
21+
}
22+
}

examples/v2/dora-metrics/GetDORAFailure.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Get a failure event returns "OK" response
1+
// Get an incident event returns "OK" response
22

33
import com.datadog.api.client.ApiClient;
44
import com.datadog.api.client.ApiException;

examples/v2/dora-metrics/ListDORAFailures.java

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

33
import com.datadog.api.client.ApiClient;
44
import com.datadog.api.client.ApiException;
@@ -21,9 +21,11 @@ public static void main(String[] args) {
2121
new DORAListFailuresRequestData()
2222
.attributes(
2323
new DORAListFailuresRequestAttributes()
24-
.from(OffsetDateTime.parse("2025-03-23T00:00:00Z"))
25-
.limit(1)
26-
.to(OffsetDateTime.parse("2025-03-24T00:00:00Z")))
24+
.from(OffsetDateTime.parse("2025-01-01T00:00:00Z"))
25+
.limit(100)
26+
.query("severity:(SEV-1 OR SEV-2) env:production team:backend")
27+
.sort("-started_at")
28+
.to(OffsetDateTime.parse("2025-01-31T23:59:59Z")))
2729
.type(DORAListFailuresRequestDataType.DORA_FAILURES_LIST_REQUEST));
2830

2931
try {

0 commit comments

Comments
 (0)