Skip to content

Commit bea00be

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

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

examples/v2/dora-metrics/CreateDORADeployment.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Send a deployment event for DORA Metrics returns "OK" response
2+
Send a deployment event returns "OK" response
33
"""
44

55
from datadog_api_client import ApiClient, Configuration

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 for DORA Metrics returns "OK - but delayed due to incident" response
2+
Send a failure event returns "OK - but delayed due to incident" 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 for DORA Metrics returns "OK" response
2+
Send an incident event returns "OK" response
33
"""
44

55
from datadog_api_client import ApiClient, Configuration

examples/v2/dora-metrics/CreateDORAIncident_1768887482.py renamed to examples/v2/dora-metrics/CreateDORAIncident_1101664022.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 for DORA Metrics returns "OK" response
2+
Send a failure event returns "OK" response
33
"""
44

55
from datadog_api_client import ApiClient, Configuration

src/datadog_api_client/v2/api/dora_metrics_api.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -226,9 +226,9 @@ def create_dora_deployment(
226226
self,
227227
body: DORADeploymentRequest,
228228
) -> DORADeploymentResponse:
229-
"""Send a deployment event for DORA Metrics.
229+
"""Send a deployment event.
230230
231-
Use this API endpoint to provide data about deployments for DORA metrics.
231+
Use this API endpoint to provide deployment data.
232232
233233
This is necessary for:
234234
@@ -248,9 +248,9 @@ def create_dora_failure(
248248
self,
249249
body: DORAFailureRequest,
250250
) -> DORAFailureResponse:
251-
"""Send a failure event for DORA Metrics.
251+
"""Send a failure event.
252252
253-
Use this API endpoint to provide failure data for DORA metrics.
253+
Use this API endpoint to provide failure data.
254254
255255
This is necessary for:
256256
@@ -269,11 +269,11 @@ def create_dora_incident(
269269
self,
270270
body: DORAFailureRequest,
271271
) -> DORAFailureResponse:
272-
"""Send an incident event for DORA Metrics. **Deprecated**.
272+
"""Send an incident event. **Deprecated**.
273273
274274
**Note** : This endpoint is deprecated. Please use ``/api/v2/dora/failure`` instead.
275275
276-
Use this API endpoint to provide failure data for DORA metrics.
276+
Use this API endpoint to provide failure data.
277277
278278
This is necessary for:
279279

src/datadog_api_client/v2/model/dora_deployment_request_attributes.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ def __init__(
6969
:param env: Environment name to where the service was deployed.
7070
:type env: str, optional
7171
72-
:param finished_at: Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour.
72+
:param finished_at: Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds.
7373
:type finished_at: int
7474
7575
:param git: Git info for DORA Metrics events.

tests/v2/cassettes/test_scenarios/test_send_a_deployment_event_for_dora_metrics_returns_ok_response.frozen renamed to tests/v2/cassettes/test_scenarios/test_send_a_deployment_event_returns_ok_response.frozen

File renamed without changes.

tests/v2/cassettes/test_scenarios/test_send_a_deployment_event_for_dora_metrics_returns_ok_response.yaml renamed to tests/v2/cassettes/test_scenarios/test_send_a_deployment_event_returns_ok_response.yaml

File renamed without changes.

tests/v2/cassettes/test_scenarios/test_send_a_failure_event_for_dora_metrics_returns_ok_response.frozen renamed to tests/v2/cassettes/test_scenarios/test_send_a_failure_event_returns_ok_response.frozen

File renamed without changes.

0 commit comments

Comments
 (0)