diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index a0d181216789..79c3e338ffb0 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -13717,8 +13717,7 @@ components: type: string finished_at: description: Unix timestamp when the deployment finished. It must be in - nanoseconds, milliseconds, or seconds, and it should not be older than - 1 hour. + nanoseconds, milliseconds, or seconds. example: 1693491984000000000 format: int64 type: integer @@ -57663,8 +57662,7 @@ paths: - manage_log_reports /api/v2/dora/deployment: post: - description: 'Use this API endpoint to provide data about deployments for DORA - metrics. + description: 'Use this API endpoint to provide deployment data. This is necessary for: @@ -57706,7 +57704,7 @@ paths: $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] - summary: Send a deployment event for DORA Metrics + summary: Send a deployment event tags: - DORA Metrics x-codegen-request-body-name: body @@ -57823,7 +57821,7 @@ paths: - dora_metrics_read /api/v2/dora/failure: post: - description: 'Use this API endpoint to provide failure data for DORA metrics. + description: 'Use this API endpoint to provide failure data. This is necessary for: @@ -57863,7 +57861,7 @@ paths: $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] - summary: Send a failure event for DORA Metrics + summary: Send a failure event tags: - DORA Metrics x-codegen-request-body-name: body @@ -57985,7 +57983,7 @@ paths: instead. - Use this API endpoint to provide failure data for DORA metrics. + Use this API endpoint to provide failure data. This is necessary for: @@ -58025,7 +58023,7 @@ paths: $ref: '#/components/responses/TooManyRequestsResponse' security: - apiKeyAuth: [] - summary: Send an incident event for DORA Metrics + summary: Send an incident event tags: - DORA Metrics x-codegen-request-body-name: body diff --git a/cassettes/v2/DORA-Metrics_482886860/Send-a-deployment-event-for-DORA-Metrics-returns-OK-response_3631369903/frozen.json b/cassettes/v2/DORA-Metrics_482886860/Send-a-deployment-event-returns-OK-response_1261677333/frozen.json similarity index 100% rename from cassettes/v2/DORA-Metrics_482886860/Send-a-deployment-event-for-DORA-Metrics-returns-OK-response_3631369903/frozen.json rename to cassettes/v2/DORA-Metrics_482886860/Send-a-deployment-event-returns-OK-response_1261677333/frozen.json diff --git a/cassettes/v2/DORA-Metrics_482886860/Send-a-deployment-event-for-DORA-Metrics-returns-OK-response_3631369903/recording.har b/cassettes/v2/DORA-Metrics_482886860/Send-a-deployment-event-returns-OK-response_1261677333/recording.har similarity index 95% rename from cassettes/v2/DORA-Metrics_482886860/Send-a-deployment-event-for-DORA-Metrics-returns-OK-response_3631369903/recording.har rename to cassettes/v2/DORA-Metrics_482886860/Send-a-deployment-event-returns-OK-response_1261677333/recording.har index 5e0898679390..96dd1a567acf 100644 --- a/cassettes/v2/DORA-Metrics_482886860/Send-a-deployment-event-for-DORA-Metrics-returns-OK-response_3631369903/recording.har +++ b/cassettes/v2/DORA-Metrics_482886860/Send-a-deployment-event-returns-OK-response_1261677333/recording.har @@ -1,6 +1,6 @@ { "log": { - "_recordingName": "DORA Metrics/Send a deployment event for DORA Metrics returns \"OK\" response", + "_recordingName": "DORA Metrics/Send a deployment event returns \"OK\" response", "creator": { "comment": "persister:fs", "name": "Polly.JS", diff --git a/cassettes/v2/DORA-Metrics_482886860/Send-a-failure-event-for-DORA-Metrics-returns-OK-response_1860345512/frozen.json b/cassettes/v2/DORA-Metrics_482886860/Send-a-failure-event-returns-OK-response_1998826192/frozen.json similarity index 100% rename from cassettes/v2/DORA-Metrics_482886860/Send-a-failure-event-for-DORA-Metrics-returns-OK-response_1860345512/frozen.json rename to cassettes/v2/DORA-Metrics_482886860/Send-a-failure-event-returns-OK-response_1998826192/frozen.json diff --git a/cassettes/v2/DORA-Metrics_482886860/Send-a-failure-event-for-DORA-Metrics-returns-OK-response_1860345512/recording.har b/cassettes/v2/DORA-Metrics_482886860/Send-a-failure-event-returns-OK-response_1998826192/recording.har similarity index 95% rename from cassettes/v2/DORA-Metrics_482886860/Send-a-failure-event-for-DORA-Metrics-returns-OK-response_1860345512/recording.har rename to cassettes/v2/DORA-Metrics_482886860/Send-a-failure-event-returns-OK-response_1998826192/recording.har index de203c9206bb..b0394d4f8b8a 100644 --- a/cassettes/v2/DORA-Metrics_482886860/Send-a-failure-event-for-DORA-Metrics-returns-OK-response_1860345512/recording.har +++ b/cassettes/v2/DORA-Metrics_482886860/Send-a-failure-event-returns-OK-response_1998826192/recording.har @@ -1,6 +1,6 @@ { "log": { - "_recordingName": "DORA Metrics/Send a failure event for DORA Metrics returns \"OK\" response", + "_recordingName": "DORA Metrics/Send a failure event returns \"OK\" response", "creator": { "comment": "persister:fs", "name": "Polly.JS", diff --git a/features/v2/dora_metrics.feature b/features/v2/dora_metrics.feature index 6352e0e5584f..b11b0fc74df5 100644 --- a/features/v2/dora_metrics.feature +++ b/features/v2/dora_metrics.feature @@ -105,63 +105,63 @@ Feature: DORA Metrics Then the response status is 200 OK @skip @team:DataDog/ci-app-backend - Scenario: Send a deployment event for DORA Metrics returns "Bad Request" response + Scenario: Send a deployment event returns "Bad Request" response Given new "CreateDORADeployment" request And body with value {"data": {"attributes": {}}} When the request is sent Then the response status is 400 Bad Request @generated @skip @team:DataDog/ci-app-backend - Scenario: Send a deployment event for DORA Metrics returns "OK - but delayed due to incident" response + Scenario: Send a deployment event returns "OK - but delayed due to incident" response Given new "CreateDORADeployment" request And body with value {"data": {"attributes": {"custom_tags": ["language:java", "department:engineering"], "env": "staging", "finished_at": 1693491984000000000, "git": {"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", "repository_url": "https://github.com/organization/example-repository"}, "service": "shopist", "started_at": 1693491974000000000, "team": "backend", "version": "v1.12.07"}}} When the request is sent Then the response status is 202 OK - but delayed due to incident @replay-only @team:DataDog/ci-app-backend - Scenario: Send a deployment event for DORA Metrics returns "OK" response + Scenario: Send a deployment event returns "OK" response Given new "CreateDORADeployment" request And body with value {"data": {"attributes": {"finished_at": 1693491984000000000, "git": {"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", "repository_url": "https://github.com/organization/example-repository"}, "service": "shopist", "started_at": 1693491974000000000, "version": "v1.12.07"}}} When the request is sent Then the response status is 200 OK @skip @team:DataDog/ci-app-backend - Scenario: Send a failure event for DORA Metrics returns "Bad Request" response + Scenario: Send a failure event returns "Bad Request" response Given new "CreateDORAIncident" request And body with value {"data": {"attributes": {}}} When the request is sent Then the response status is 400 Bad Request @generated @skip @team:DataDog/ci-app-backend - Scenario: Send a failure event for DORA Metrics returns "OK - but delayed due to incident" response + Scenario: Send a failure event returns "OK - but delayed due to incident" response Given new "CreateDORAFailure" request And body with value {"data": {"attributes": {"custom_tags": ["language:java", "department:engineering"], "env": "staging", "finished_at": 1693491984000000000, "git": {"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", "repository_url": "https://github.com/organization/example-repository"}, "name": "Webserver is down failing all requests.", "services": ["shopist"], "severity": "High", "started_at": 1693491974000000000, "team": "backend", "version": "v1.12.07"}}} When the request is sent Then the response status is 202 OK - but delayed due to incident @replay-only @team:DataDog/ci-app-backend - Scenario: Send a failure event for DORA Metrics returns "OK" response + Scenario: Send a failure event returns "OK" response Given new "CreateDORAIncident" request And body with value {"data": {"attributes": {"finished_at": 1707842944600000000, "git": {"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", "repository_url": "https://github.com/organization/example-repository"}, "name": "Webserver is down failing all requests", "services": ["shopist"], "severity": "High", "started_at": 1707842944500000000, "team": "backend", "version": "v1.12.07"}}} When the request is sent Then the response status is 200 OK @generated @skip @team:DataDog/ci-app-backend - Scenario: Send an incident event for DORA Metrics returns "Bad Request" response + Scenario: Send an incident event returns "Bad Request" response Given new "CreateDORAIncident" request And body with value {"data": {"attributes": {"custom_tags": ["language:java", "department:engineering"], "env": "staging", "finished_at": 1693491984000000000, "git": {"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", "repository_url": "https://github.com/organization/example-repository"}, "name": "Webserver is down failing all requests.", "services": ["shopist"], "severity": "High", "started_at": 1693491974000000000, "team": "backend", "version": "v1.12.07"}}} When the request is sent Then the response status is 400 Bad Request @generated @skip @team:DataDog/ci-app-backend - Scenario: Send an incident event for DORA Metrics returns "OK - but delayed due to incident" response + Scenario: Send an incident event returns "OK - but delayed due to incident" response Given new "CreateDORAIncident" request And body with value {"data": {"attributes": {"custom_tags": ["language:java", "department:engineering"], "env": "staging", "finished_at": 1693491984000000000, "git": {"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", "repository_url": "https://github.com/organization/example-repository"}, "name": "Webserver is down failing all requests.", "services": ["shopist"], "severity": "High", "started_at": 1693491974000000000, "team": "backend", "version": "v1.12.07"}}} When the request is sent Then the response status is 202 OK - but delayed due to incident @generated @skip @team:DataDog/ci-app-backend - Scenario: Send an incident event for DORA Metrics returns "OK" response + Scenario: Send an incident event returns "OK" response Given new "CreateDORAIncident" request And body with value {"data": {"attributes": {"custom_tags": ["language:java", "department:engineering"], "env": "staging", "finished_at": 1693491984000000000, "git": {"commit_sha": "66adc9350f2cc9b250b69abddab733dd55e1a588", "repository_url": "https://github.com/organization/example-repository"}, "name": "Webserver is down failing all requests.", "services": ["shopist"], "severity": "High", "started_at": 1693491974000000000, "team": "backend", "version": "v1.12.07"}}} When the request is sent diff --git a/services/dora_metrics/src/v2/DORAMetricsApi.ts b/services/dora_metrics/src/v2/DORAMetricsApi.ts index 9ece533618b9..b7d22c624815 100644 --- a/services/dora_metrics/src/v2/DORAMetricsApi.ts +++ b/services/dora_metrics/src/v2/DORAMetricsApi.ts @@ -1217,7 +1217,7 @@ export class DORAMetricsApi { } /** - * Use this API endpoint to provide data about deployments for DORA metrics. + * Use this API endpoint to provide deployment data. * * This is necessary for: * - Deployment Frequency @@ -1243,7 +1243,7 @@ export class DORAMetricsApi { } /** - * Use this API endpoint to provide failure data for DORA metrics. + * Use this API endpoint to provide failure data. * * This is necessary for: * - Change Failure Rate @@ -1270,7 +1270,7 @@ export class DORAMetricsApi { /** * **Note**: This endpoint is deprecated. Please use `/api/v2/dora/failure` instead. * - * Use this API endpoint to provide failure data for DORA metrics. + * Use this API endpoint to provide failure data. * * This is necessary for: * - Change Failure Rate diff --git a/services/dora_metrics/src/v2/models/DORADeploymentRequestAttributes.ts b/services/dora_metrics/src/v2/models/DORADeploymentRequestAttributes.ts index d1f1f84292b1..9abc473b45ec 100644 --- a/services/dora_metrics/src/v2/models/DORADeploymentRequestAttributes.ts +++ b/services/dora_metrics/src/v2/models/DORADeploymentRequestAttributes.ts @@ -15,7 +15,7 @@ export class DORADeploymentRequestAttributes { */ "env"?: string; /** - * Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour. + * Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds. */ "finishedAt": number; /**