Skip to content

Commit d277ed9

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Add Public Delete Dora Events Endpoints (#2757)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 9e8a729 commit d277ed9

File tree

8 files changed

+437
-4
lines changed

8 files changed

+437
-4
lines changed

‎.generator/schemas/v2/openapi.yaml‎

Lines changed: 70 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56843,6 +56843,40 @@ paths:
5684356843
tags:
5684456844
- DORA Metrics
5684556845
x-codegen-request-body-name: body
56846+
/api/v2/dora/deployment/{deployment_id}:
56847+
delete:
56848+
description: Use this API endpoint to delete a deployment event.
56849+
operationId: DeleteDORADeployment
56850+
parameters:
56851+
- description: The ID of the deployment event to delete.
56852+
in: path
56853+
name: deployment_id
56854+
required: true
56855+
schema:
56856+
type: string
56857+
responses:
56858+
'202':
56859+
description: Accepted
56860+
'400':
56861+
content:
56862+
application/json:
56863+
schema:
56864+
$ref: '#/components/schemas/JSONAPIErrorResponse'
56865+
description: Bad Request
56866+
'403':
56867+
$ref: '#/components/responses/NotAuthorizedResponse'
56868+
'429':
56869+
$ref: '#/components/responses/TooManyRequestsResponse'
56870+
security:
56871+
- apiKeyAuth: []
56872+
- appKeyAuth: []
56873+
summary: Delete a deployment event
56874+
tags:
56875+
- DORA Metrics
56876+
x-permission:
56877+
operator: OR
56878+
permissions:
56879+
- dora_metrics_write
5684656880
/api/v2/dora/deployments:
5684756881
post:
5684856882
description: Use this API endpoint to get a list of deployment events.
@@ -56966,6 +57000,40 @@ paths:
5696657000
tags:
5696757001
- DORA Metrics
5696857002
x-codegen-request-body-name: body
57003+
/api/v2/dora/failure/{failure_id}:
57004+
delete:
57005+
description: Use this API endpoint to delete a failure event.
57006+
operationId: DeleteDORAFailure
57007+
parameters:
57008+
- description: The ID of the failure event to delete.
57009+
in: path
57010+
name: failure_id
57011+
required: true
57012+
schema:
57013+
type: string
57014+
responses:
57015+
'202':
57016+
description: Accepted
57017+
'400':
57018+
content:
57019+
application/json:
57020+
schema:
57021+
$ref: '#/components/schemas/JSONAPIErrorResponse'
57022+
description: Bad Request
57023+
'403':
57024+
$ref: '#/components/responses/NotAuthorizedResponse'
57025+
'429':
57026+
$ref: '#/components/responses/TooManyRequestsResponse'
57027+
security:
57028+
- apiKeyAuth: []
57029+
- appKeyAuth: []
57030+
summary: Delete a failure event
57031+
tags:
57032+
- DORA Metrics
57033+
x-permission:
57034+
operator: OR
57035+
permissions:
57036+
- dora_metrics_write
5696957037
/api/v2/dora/failures:
5697057038
post:
5697157039
description: Use this API endpoint to get a list of failure events.
@@ -75655,8 +75723,8 @@ tags:
7565575723
See the [Container Monitoring page](https://docs.datadoghq.com/containers/) for
7565675724
more information.
7565775725
name: Containers
75658-
- description: 'Search or send events for DORA Metrics to measure and improve your
75659-
software delivery performance. See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/)
75726+
- description: 'Search, send, or delete events for DORA Metrics to measure and improve
75727+
your software delivery performance. See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/)
7566075728
for more information.
7566175729

7566275730

‎examples/v2/dora-metrics/DeleteDORADeployment.ts‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/**
2+
* Delete a deployment 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.DORAMetricsApiDeleteDORADeploymentRequest = {
11+
deploymentId: "NO_VALUE",
12+
};
13+
14+
apiInstance
15+
.deleteDORADeployment(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/DeleteDORAFailure.ts‎

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));

‎features/support/scenarios_model_mapping.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4994,6 +4994,13 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
49944994
},
49954995
"operationResponseType": "DORADeploymentResponse",
49964996
},
4997+
"v2.DeleteDORADeployment": {
4998+
"deploymentId": {
4999+
"type": "string",
5000+
"format": "",
5001+
},
5002+
"operationResponseType": "{}",
5003+
},
49975004
"v2.ListDORADeployments": {
49985005
"body": {
49995006
"type": "DORAListDeploymentsRequest",
@@ -5015,6 +5022,13 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
50155022
},
50165023
"operationResponseType": "DORAFailureResponse",
50175024
},
5025+
"v2.DeleteDORAFailure": {
5026+
"failureId": {
5027+
"type": "string",
5028+
"format": "",
5029+
},
5030+
"operationResponseType": "{}",
5031+
},
50185032
"v2.ListDORAFailures": {
50195033
"body": {
50205034
"type": "DORAListFailuresRequest",

‎features/v2/dora_metrics.feature‎

Lines changed: 33 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,45 @@
11
@endpoint(dora-metrics) @endpoint(dora-metrics-v2)
22
Feature: DORA Metrics
3-
Search or send events for DORA Metrics to measure and improve your
4-
software delivery performance. See the [DORA Metrics
3+
Search, send, or delete events for DORA Metrics to measure and improve
4+
your software delivery performance. See the [DORA Metrics
55
page](https://docs.datadoghq.com/dora_metrics/) for more information.
66
**Note**: DORA Metrics are not available in the US1-FED site.
77

88
Background:
99
Given a valid "apiKeyAuth" key in the system
1010
And an instance of "DORAMetrics" API
1111

12+
@skip @team:DataDog/ci-app-backend
13+
Scenario: Delete a deployment event returns "Accepted" response
14+
Given new "DeleteDORADeployment" request
15+
And a valid "appKeyAuth" key in the system
16+
And request contains "deployment_id" parameter with value "NO_VALUE"
17+
When the request is sent
18+
Then the response status is 202 Accepted
19+
20+
@skip @team:DataDog/ci-app-backend
21+
Scenario: Delete a deployment event returns "Bad Request" response
22+
Given new "DeleteDORADeployment" request
23+
And request contains "deployment_id" parameter from "REPLACE.ME"
24+
When the request is sent
25+
Then the response status is 400 Bad Request
26+
27+
@skip @team:DataDog/ci-app-backend
28+
Scenario: Delete a failure event returns "Accepted" response
29+
Given new "DeleteDORAFailure" request
30+
And a valid "appKeyAuth" key in the system
31+
And request contains "failure_id" parameter with value "NO_VALUE"
32+
When the request is sent
33+
Then the response status is 202 Accepted
34+
35+
@skip @team:DataDog/ci-app-backend
36+
Scenario: Delete a failure event returns "Bad Request" response
37+
Given new "DeleteDORAFailure" request
38+
And a valid "appKeyAuth" key in the system
39+
And request contains "failure_id" parameter from "REPLACE.ME"
40+
When the request is sent
41+
Then the response status is 400 Bad Request
42+
1243
@generated @skip @team:DataDog/ci-app-backend
1344
Scenario: Get a deployment event returns "Bad Request" response
1445
Given new "GetDORADeployment" request

‎features/v2/undo.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1064,6 +1064,12 @@
10641064
"type": "idempotent"
10651065
}
10661066
},
1067+
"DeleteDORADeployment": {
1068+
"tag": "DORA Metrics",
1069+
"undo": {
1070+
"type": "idempotent"
1071+
}
1072+
},
10671073
"ListDORADeployments": {
10681074
"tag": "DORA Metrics",
10691075
"undo": {
@@ -1082,6 +1088,12 @@
10821088
"type": "idempotent"
10831089
}
10841090
},
1091+
"DeleteDORAFailure": {
1092+
"tag": "DORA Metrics",
1093+
"undo": {
1094+
"type": "idempotent"
1095+
}
1096+
},
10851097
"ListDORAFailures": {
10861098
"tag": "DORA Metrics",
10871099
"undo": {

0 commit comments

Comments
 (0)