Regenerate client from commit 21c3f98 of spec repo

Author: ci.datadog-api-spec

.generator/schemas/v2/openapi.yaml

@@ -17457,10 +17457,12 @@ components:
       - finished_at
       type: object
     DORADeploymentPatchRemediation:
-      description: Remediation details for the deployment.
+      description: Remediation details for the deployment. Optional, but required
+        to calculate failed deployment recovery time.
       properties:
         id:
-          description: The ID of the remediation action.
+          description: The ID of the remediation deployment. Required when the type
+            field is provided.
           example: eG42zNIkVjM
           type: string
         type:
@@ -17470,7 +17472,8 @@ components:
       - type
       type: object
     DORADeploymentPatchRemediationType:
-      description: The type of remediation action taken.
+      description: The type of remediation action taken. Required when the id field
+        is provided.
       enum:
       - rollback
       - rollforward
@@ -17674,47 +17677,47 @@ components:
           type: array
       type: object
     DORAFailureFetchResponse:
-      description: Response for fetching a single failure event.
+      description: Response for fetching a single incident event.
       properties:
         data:
           $ref: '#/components/schemas/DORAIncidentObject'
       type: object
     DORAFailureRequest:
-      description: Request to create a DORA failure event.
+      description: Request to create a DORA incident event.
       properties:
         data:
           $ref: '#/components/schemas/DORAFailureRequestData'
       required:
       - data
       type: object
     DORAFailureRequestAttributes:
-      description: Attributes to create a DORA failure event.
+      description: Attributes to create a DORA incident event.
       properties:
         custom_tags:
           $ref: '#/components/schemas/DORACustomTags'
         env:
-          description: Environment name that was impacted by the failure.
+          description: Environment name that was impacted by the incident.
           example: staging
           type: string
         finished_at:
-          description: Unix timestamp when the failure finished. It must be in nanoseconds,
+          description: Unix timestamp when the incident finished. It must be in nanoseconds,
             milliseconds, or seconds.
           example: 1693491984000000000
           format: int64
           type: integer
         git:
           $ref: '#/components/schemas/DORAGitInfo'
         id:
-          description: Failure ID. Must be 16-128 characters and contain only alphanumeric
+          description: Incident ID. Must be 16-128 characters and contain only alphanumeric
             characters, hyphens, underscores, periods, and colons (a-z, A-Z, 0-9,
             -, _, ., :).
           type: string
         name:
-          description: Failure name.
+          description: Incident name.
           example: Webserver is down failing all requests.
           type: string
         services:
-          description: Service names impacted by the failure. If possible, use names
+          description: Service names impacted by the incident. If possible, use names
             registered in the Service Catalog. Required when the team field is not
             provided.
           example:
@@ -17723,11 +17726,11 @@ components:
             type: string
           type: array
         severity:
-          description: Failure severity.
+          description: Incident severity.
           example: High
           type: string
         started_at:
-          description: Unix timestamp when the failure started. It must be in nanoseconds,
+          description: Unix timestamp when the incident started. It must be in nanoseconds,
             milliseconds, or seconds.
           example: 1693491974000000000
           format: int64
@@ -17754,18 +17757,18 @@ components:
       - attributes
       type: object
     DORAFailureResponse:
-      description: Response after receiving a DORA failure event.
+      description: Response after receiving a DORA incident event.
       properties:
         data:
           $ref: '#/components/schemas/DORAFailureResponseData'
       required:
       - data
       type: object
     DORAFailureResponseData:
-      description: Response after receiving a DORA failure event.
+      description: Response after receiving a DORA incident event.
       properties:
         id:
-          description: The ID of the received DORA failure event.
+          description: The ID of the received DORA incident event.
           example: 4242fcdd31586083
           type: string
         type:
@@ -17775,15 +17778,15 @@ components:
       type: object
     DORAFailureType:
       default: dora_failure
-      description: JSON:API type for DORA failure events.
+      description: JSON:API type for DORA incident events.
       enum:
       - dora_failure
       example: dora_failure
       type: string
       x-enum-varnames:
       - DORA_FAILURE
     DORAFailuresListResponse:
-      description: Response for the list failures endpoint.
+      description: Response for the list incidents endpoint.
       example:
         data:
         - attributes:
@@ -17917,7 +17920,7 @@ components:
             from: '2025-01-01T00:00:00Z'
             limit: 100
             query: service:(shopist OR api-service) env:production team:backend
-            sort: -started_at
+            sort: -finished_at
             to: '2025-01-31T23:59:59Z'
           type: dora_deployments_list_request
       properties:
@@ -17984,7 +17987,7 @@ components:
       x-enum-varnames:
       - DORA_DEPLOYMENTS_LIST_REQUEST
     DORAListFailuresRequest:
-      description: Request to get a list of failures.
+      description: Request to get a list of incidents.
       example:
         data:
           attributes:
@@ -18001,7 +18004,7 @@ components:
       - data
       type: object
     DORAListFailuresRequestAttributes:
-      description: Attributes to get a list of failures.
+      description: Attributes to get a list of incidents.
       properties:
         from:
           description: Minimum timestamp for requested events.
@@ -76477,7 +76480,9 @@ paths:
 
         - Change Lead Time
 
-        - Change Failure Rate'
+        - Change Failure Rate
+
+        - Failed Deployment Recovery Time'
       operationId: CreateDORADeployment
       requestBody:
         content:
@@ -76626,7 +76631,13 @@ paths:
         permissions:
         - dora_metrics_read
     patch:
-      description: Use this API endpoint to patch a deployment event.
+      description: 'Update a deployment''s change failure status. Use this to mark
+        a deployment as a change
+
+        failure or back to stable. You can optionally include remediation details
+        to enable
+
+        failed deployment recovery time calculation.'
       operationId: PatchDORADeployment
       parameters:
       - description: The ID of the deployment event.
@@ -76667,14 +76678,18 @@ paths:
         - dora_metrics_write
   /api/v2/dora/failure:
     post:
-      description: 'Use this API endpoint to provide failure data.
+      description: 'Use this API endpoint to provide incident data for DORA Metrics.
 
+        Note that change failure rate and failed deployment recovery time are computed
+        from
 
-        This is necessary for:
+        change failures detected on deployments,
 
-        - Change Failure Rate
+        not from incident events sent through this endpoint.
+
+        Tracking incidents gives a side-by-side view of how failed deployments translate
 
-        - Time to Restore'
+        into real-world incidents, including their severity and frequency.'
       operationId: CreateDORAFailure
       requestBody:
         content:
@@ -76707,16 +76722,16 @@ paths:
           $ref: '#/components/responses/TooManyRequestsResponse'
       security:
       - apiKeyAuth: []
-      summary: Send a failure event
+      summary: Send an incident event
       tags:
       - DORA Metrics
       x-codegen-request-body-name: body
   /api/v2/dora/failure/{failure_id}:
     delete:
-      description: Use this API endpoint to delete a failure event.
+      description: Use this API endpoint to delete an incident event.
       operationId: DeleteDORAFailure
       parameters:
-      - description: The ID of the failure event to delete.
+      - description: The ID of the incident event to delete.
         in: path
         name: failure_id
         required: true
@@ -76738,7 +76753,7 @@ paths:
       security:
       - apiKeyAuth: []
         appKeyAuth: []
-      summary: Delete a failure event
+      summary: Delete an incident event
       tags:
       - DORA Metrics
       x-permission:
@@ -76747,7 +76762,7 @@ paths:
         - dora_metrics_write
   /api/v2/dora/failures:
     post:
-      description: Use this API endpoint to get a list of failure events.
+      description: Use this API endpoint to get a list of incident events.
       operationId: ListDORAFailures
       requestBody:
         content:
@@ -76775,7 +76790,7 @@ paths:
       security:
       - apiKeyAuth: []
         appKeyAuth: []
-      summary: Get a list of failure events
+      summary: Get a list of incident events
       tags:
       - DORA Metrics
       x-codegen-request-body-name: body
@@ -76785,10 +76800,10 @@ paths:
         - dora_metrics_read
   /api/v2/dora/failures/{failure_id}:
     get:
-      description: Use this API endpoint to get a failure event.
+      description: Use this API endpoint to get an incident event.
       operationId: GetDORAFailure
       parameters:
-      - description: The ID of the failure event.
+      - description: The ID of the incident event.
         in: path
         name: failure_id
         required: true
@@ -76814,7 +76829,7 @@ paths:
       security:
       - apiKeyAuth: []
         appKeyAuth: []
-      summary: Get a failure event
+      summary: Get an incident event
       tags:
       - DORA Metrics
       x-codegen-request-body-name: body
@@ -76829,14 +76844,10 @@ paths:
         instead.
 
 
-        Use this API endpoint to provide failure data.
+        Use this API endpoint to provide incident data.
 
-
-        This is necessary for:
-
-        - Change Failure Rate
-
-        - Time to Restore'
+        Tracking incidents gives a side-by-side view of how failed deployments translate
+        into real-world incidents.'
       operationId: CreateDORAIncident
       requestBody:
         content:
@@ -76869,7 +76880,7 @@ paths:
           $ref: '#/components/responses/TooManyRequestsResponse'
       security:
       - apiKeyAuth: []
-      summary: Send an incident event
+      summary: Send an incident event (deprecated)
       tags:
       - DORA Metrics
       x-codegen-request-body-name: body

examples/v2/dora-metrics/CreateDORAFailure.ts

@@ -1,5 +1,5 @@
 /**
- * Send a failure event returns "OK - but delayed due to incident" response
+ * Send an incident event returns "OK" response
  */
 
 import { client, v2 } from "@datadog/datadog-api-client";

examples/v2/dora-metrics/CreateDORAIncident.ts

@@ -1,5 +1,5 @@
 /**
- * Send an incident event returns "OK" response
+ * Send an incident event (deprecated) returns "OK" response
  */
 
 import { client, v2 } from "@datadog/datadog-api-client";

examples/v2/dora-metrics/DeleteDORAFailure.ts

@@ -1,5 +1,5 @@
 /**
- * Delete a failure event returns "Accepted" response
+ * Delete an incident event returns "Accepted" response
  */
 
 import { client, v2 } from "@datadog/datadog-api-client";
@@ -8,7 +8,7 @@ const configuration = client.createConfiguration();
 const apiInstance = new v2.DORAMetricsApi(configuration);
 
 const params: v2.DORAMetricsApiDeleteDORAFailureRequest = {
-  failureId: "NO_VALUE",
+  failureId: "failure_id",
 };
 
 apiInstance

examples/v2/dora-metrics/DeleteDORAFailure_3462074974.ts

@@ -0,0 +1,21 @@
+/**
+ * Delete a failure event returns "Accepted" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.DORAMetricsApi(configuration);
+
+const params: v2.DORAMetricsApiDeleteDORAFailureRequest = {
+  failureId: "NO_VALUE",
+};
+
+apiInstance
+  .deleteDORAFailure(params)
+  .then((data: any) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

examples/v2/dora-metrics/GetDORAFailure.ts

@@ -1,5 +1,5 @@
 /**
- * Get a failure event returns "OK" response
+ * Get an incident event returns "OK" response
  */
 
 import { client, v2 } from "@datadog/datadog-api-client";

examples/v2/dora-metrics/ListDORAFailures.ts

@@ -1,5 +1,5 @@
 /**
- * Get a list of failure events returns "OK" response
+ * Get a list of incident events returns "OK" response
  */
 
 import { client, v2 } from "@datadog/datadog-api-client";
@@ -11,9 +11,11 @@ const params: v2.DORAMetricsApiListDORAFailuresRequest = {
   body: {
     data: {
       attributes: {
-        from: new Date(2025, 3, 23, 0, 0, 0, 0),
-        limit: 1,
-        to: new Date(2025, 3, 24, 0, 0, 0, 0),
+        from: new Date(2025, 1, 1, 0, 0, 0, 0),
+        limit: 100,
+        query: "severity:(SEV-1 OR SEV-2) env:production team:backend",
+        sort: "-started_at",
+        to: new Date(2025, 1, 31, 23, 59, 59, 0),
       },
       type: "dora_failures_list_request",
     },