Skip to content

Commit 0361c97

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
[SDCD-1826] Update DORA endpoints description and name (#3392)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 04786a3 commit 0361c97

12 files changed

+27
-29
lines changed

.generator/schemas/v2/openapi.yaml

Lines changed: 7 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13717,8 +13717,7 @@ components:
1371713717
type: string
1371813718
finished_at:
1371913719
description: Unix timestamp when the deployment finished. It must be in
13720-
nanoseconds, milliseconds, or seconds, and it should not be older than
13721-
1 hour.
13720+
nanoseconds, milliseconds, or seconds.
1372213721
example: 1693491984000000000
1372313722
format: int64
1372413723
type: integer
@@ -57663,8 +57662,7 @@ paths:
5766357662
- manage_log_reports
5766457663
/api/v2/dora/deployment:
5766557664
post:
57666-
description: 'Use this API endpoint to provide data about deployments for DORA
57667-
metrics.
57665+
description: 'Use this API endpoint to provide deployment data.
5766857666

5766957667

5767057668
This is necessary for:
@@ -57706,7 +57704,7 @@ paths:
5770657704
$ref: '#/components/responses/TooManyRequestsResponse'
5770757705
security:
5770857706
- apiKeyAuth: []
57709-
summary: Send a deployment event for DORA Metrics
57707+
summary: Send a deployment event
5771057708
tags:
5771157709
- DORA Metrics
5771257710
x-codegen-request-body-name: body
@@ -57823,7 +57821,7 @@ paths:
5782357821
- dora_metrics_read
5782457822
/api/v2/dora/failure:
5782557823
post:
57826-
description: 'Use this API endpoint to provide failure data for DORA metrics.
57824+
description: 'Use this API endpoint to provide failure data.
5782757825

5782857826

5782957827
This is necessary for:
@@ -57863,7 +57861,7 @@ paths:
5786357861
$ref: '#/components/responses/TooManyRequestsResponse'
5786457862
security:
5786557863
- apiKeyAuth: []
57866-
summary: Send a failure event for DORA Metrics
57864+
summary: Send a failure event
5786757865
tags:
5786857866
- DORA Metrics
5786957867
x-codegen-request-body-name: body
@@ -57985,7 +57983,7 @@ paths:
5798557983
instead.
5798657984

5798757985

57988-
Use this API endpoint to provide failure data for DORA metrics.
57986+
Use this API endpoint to provide failure data.
5798957987

5799057988

5799157989
This is necessary for:
@@ -58025,7 +58023,7 @@ paths:
5802558023
$ref: '#/components/responses/TooManyRequestsResponse'
5802658024
security:
5802758025
- apiKeyAuth: []
58028-
summary: Send an incident event for DORA Metrics
58026+
summary: Send an incident event
5802958027
tags:
5803058028
- DORA Metrics
5803158029
x-codegen-request-body-name: body

api/datadogV2/api_dora_metrics.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ import (
1515
// DORAMetricsApi service type
1616
type DORAMetricsApi datadog.Service
1717

18-
// CreateDORADeployment Send a deployment event for DORA Metrics.
19-
// Use this API endpoint to provide data about deployments for DORA metrics.
18+
// CreateDORADeployment Send a deployment event.
19+
// Use this API endpoint to provide deployment data.
2020
//
2121
// This is necessary for:
2222
// - Deployment Frequency
@@ -102,8 +102,8 @@ func (a *DORAMetricsApi) CreateDORADeployment(ctx _context.Context, body DORADep
102102
return localVarReturnValue, localVarHTTPResponse, nil
103103
}
104104

105-
// CreateDORAFailure Send a failure event for DORA Metrics.
106-
// Use this API endpoint to provide failure data for DORA metrics.
105+
// CreateDORAFailure Send a failure event.
106+
// Use this API endpoint to provide failure data.
107107
//
108108
// This is necessary for:
109109
// - Change Failure Rate
@@ -188,10 +188,10 @@ func (a *DORAMetricsApi) CreateDORAFailure(ctx _context.Context, body DORAFailur
188188
return localVarReturnValue, localVarHTTPResponse, nil
189189
}
190190

191-
// CreateDORAIncident Send an incident event for DORA Metrics.
191+
// CreateDORAIncident Send an incident event.
192192
// **Note**: This endpoint is deprecated. Please use `/api/v2/dora/failure` instead.
193193
//
194-
// Use this API endpoint to provide failure data for DORA metrics.
194+
// Use this API endpoint to provide failure data.
195195
//
196196
// This is necessary for:
197197
// - Change Failure Rate

api/datadogV2/model_dora_deployment_request_attributes.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ type DORADeploymentRequestAttributes struct {
1616
CustomTags datadog.NullableList[string] `json:"custom_tags,omitempty"`
1717
// Environment name to where the service was deployed.
1818
Env *string `json:"env,omitempty"`
19-
// Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour.
19+
// Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds.
2020
FinishedAt int64 `json:"finished_at"`
2121
// Git info for DORA Metrics events.
2222
Git *DORAGitInfo `json:"git,omitempty"`

examples/v2/dora-metrics/CreateDORADeployment.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Send a deployment event for DORA Metrics returns "OK" response
1+
// Send a deployment event returns "OK" response
22

33
package main
44

examples/v2/dora-metrics/CreateDORAFailure.go

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

33
package main
44

examples/v2/dora-metrics/CreateDORAIncident.go

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

33
package main
44

examples/v2/dora-metrics/CreateDORAIncident_1768887482.go renamed to examples/v2/dora-metrics/CreateDORAIncident_1101664022.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
// Send a failure event for DORA Metrics returns "OK" response
1+
// Send a failure event returns "OK" response
22

33
package main
44

tests/scenarios/cassettes/TestScenarios/v2/Feature_DORA_Metrics/Scenario_Send_a_deployment_event_for_DORA_Metrics_returns_OK_response.freeze renamed to tests/scenarios/cassettes/TestScenarios/v2/Feature_DORA_Metrics/Scenario_Send_a_deployment_event_returns_OK_response.freeze

File renamed without changes.

tests/scenarios/cassettes/TestScenarios/v2/Feature_DORA_Metrics/Scenario_Send_a_deployment_event_for_DORA_Metrics_returns_OK_response.yaml renamed to tests/scenarios/cassettes/TestScenarios/v2/Feature_DORA_Metrics/Scenario_Send_a_deployment_event_returns_OK_response.yaml

File renamed without changes.

tests/scenarios/cassettes/TestScenarios/v2/Feature_DORA_Metrics/Scenario_Send_a_failure_event_for_DORA_Metrics_returns_OK_response.freeze renamed to tests/scenarios/cassettes/TestScenarios/v2/Feature_DORA_Metrics/Scenario_Send_a_failure_event_returns_OK_response.freeze

File renamed without changes.

0 commit comments

Comments
 (0)