Add public APIs to search DORA events (#2263)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-05-23 19:26:09.057799",
-            "spec_repo_commit": "471c4a2a"
+            "regenerated": "2025-05-26 12:46:05.505223",
+            "spec_repo_commit": "a6954c1c"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-05-23 19:26:09.073608",
-            "spec_repo_commit": "471c4a2a"
+            "regenerated": "2025-05-26 12:46:05.522939",
+            "spec_repo_commit": "a6954c1c"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -11083,6 +11083,25 @@ components:
       type: string
       x-enum-varnames:
       - DORA_DEPLOYMENT
+    DORAEvent:
+      description: A DORA event.
+      properties:
+        attributes:
+          description: The attributes of the event.
+          type: object
+        id:
+          description: The ID of the event.
+          type: string
+        type:
+          description: The type of the event.
+          type: string
+      type: object
+    DORAFetchResponse:
+      description: Response for the DORA fetch endpoints.
+      properties:
+        data:
+          $ref: '#/components/schemas/DORAEvent'
+      type: object
     DORAGitInfo:
       description: Git info for DORA Metrics events.
       properties:
@@ -11118,7 +11137,8 @@ components:
         git:
           $ref: '#/components/schemas/DORAGitInfo'
         id:
-          description: Incident ID. Required to update a previously sent incident.
+          description: Incident ID. Must have at least 16 characters. Required to
+            update a previously sent incident.
           type: string
         name:
           description: Incident name.
@@ -11193,6 +11213,113 @@ components:
       type: string
       x-enum-varnames:
       - DORA_INCIDENT
+    DORAListDeploymentsRequest:
+      description: Request to get a list of deployments.
+      properties:
+        data:
+          $ref: '#/components/schemas/DORAListDeploymentsRequestData'
+      required:
+      - data
+      type: object
+    DORAListDeploymentsRequestAttributes:
+      description: Attributes to get a list of deployments.
+      properties:
+        from:
+          description: Minimum timestamp for requested events.
+          format: date-time
+          type: string
+        limit:
+          default: 10
+          description: Maximum number of events in the response.
+          format: int32
+          maximum: 1000
+          type: integer
+        query:
+          description: Search query with event platform syntax.
+          type: string
+        sort:
+          description: Sort order (prefixed with `-` for descending).
+          type: string
+        to:
+          description: Maximum timestamp for requested events.
+          format: date-time
+          type: string
+      type: object
+    DORAListDeploymentsRequestData:
+      description: The JSON:API data.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/DORAListDeploymentsRequestAttributes'
+        type:
+          $ref: '#/components/schemas/DORAListDeploymentsRequestDataType'
+      required:
+      - attributes
+      type: object
+    DORAListDeploymentsRequestDataType:
+      description: The definition of `DORAListDeploymentsRequestDataType` object.
+      enum:
+      - dora_deployments_list_request
+      type: string
+      x-enum-varnames:
+      - DORA_DEPLOYMENTS_LIST_REQUEST
+    DORAListFailuresRequest:
+      description: Request to get a list of failures.
+      properties:
+        data:
+          $ref: '#/components/schemas/DORAListFailuresRequestData'
+      required:
+      - data
+      type: object
+    DORAListFailuresRequestAttributes:
+      description: Attributes to get a list of failures.
+      properties:
+        from:
+          description: Minimum timestamp for requested events.
+          format: date-time
+          type: string
+        limit:
+          default: 10
+          description: Maximum number of events in the response.
+          format: int32
+          maximum: 1000
+          type: integer
+        query:
+          description: Search query with event platform syntax.
+          type: string
+        sort:
+          description: Sort order (prefixed with `-` for descending).
+          type: string
+        to:
+          description: Maximum timestamp for requested events.
+          format: date-time
+          type: string
+      type: object
+    DORAListFailuresRequestData:
+      description: The JSON:API data.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/DORAListFailuresRequestAttributes'
+        type:
+          $ref: '#/components/schemas/DORAListFailuresRequestDataType'
+      required:
+      - attributes
+      type: object
+    DORAListFailuresRequestDataType:
+      description: The definition of `DORAListFailuresRequestDataType` object.
+      enum:
+      - dora_failures_list_request
+      type: string
+      x-enum-varnames:
+      - DORA_FAILURES_LIST_REQUEST
+    DORAListResponse:
+      description: Response for the DORA list endpoints.
+      properties:
+        data:
+          description: The list of DORA events.
+          items:
+            $ref: '#/components/schemas/DORAEvent'
+          type: array
+      type: object
     DashboardListAddItemsRequest:
       description: Request containing a list of dashboards to add.
       properties:
@@ -45654,10 +45781,163 @@ paths:
       x-unstable: '**Note**: This endpoint is in public beta.
 
         If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
+  /api/v2/dora/deployments:
+    post:
+      description: Use this API endpoint to get a list of deployment events.
+      operationId: ListDORADeployments
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DORAListDeploymentsRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DORAListResponse'
+          description: OK
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
+          description: Bad Request
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      summary: Get a list of deployment events
+      tags:
+      - DORA Metrics
+      x-codegen-request-body-name: body
+      x-permission:
+        operator: OR
+        permissions:
+        - dora_metrics_read
+  /api/v2/dora/deployments/{deployment_id}:
+    get:
+      description: Use this API endpoint to get a deployment event.
+      operationId: GetDORADeployment
+      parameters:
+      - description: The ID of the deployment event.
+        in: path
+        name: deployment_id
+        required: true
+        schema:
+          type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DORAFetchResponse'
+          description: OK
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
+          description: Bad Request
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+      - appKeyAuth: []
+      summary: Get a deployment event
+      tags:
+      - DORA Metrics
+      x-codegen-request-body-name: body
+      x-permission:
+        operator: OR
+        permissions:
+        - dora_metrics_read
+  /api/v2/dora/failures:
+    post:
+      description: Use this API endpoint to get a list of failure events.
+      operationId: ListDORAFailures
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DORAListFailuresRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DORAListResponse'
+          description: OK
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
+          description: Bad Request
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      summary: Get a list of failure events
+      tags:
+      - DORA Metrics
+      x-codegen-request-body-name: body
+      x-permission:
+        operator: OR
+        permissions:
+        - dora_metrics_read
+  /api/v2/dora/failures/{failure_id}:
+    get:
+      description: Use this API endpoint to get a failure event.
+      operationId: GetDORAFailure
+      parameters:
+      - description: The ID of the failure event.
+        in: path
+        name: failure_id
+        required: true
+        schema:
+          type: string
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/DORAFetchResponse'
+          description: OK
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
+          description: Bad Request
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+      - appKeyAuth: []
+      summary: Get a failure event
+      tags:
+      - DORA Metrics
+      x-codegen-request-body-name: body
+      x-permission:
+        operator: OR
+        permissions:
+        - dora_metrics_read
   /api/v2/dora/incident:
     post:
-      description: 'Use this API endpoint to provide data about incidents for DORA
-        metrics.
+      description: 'Use this API endpoint to provide failure data for DORA metrics.
 
 
         This is necessary for:
@@ -62027,9 +62307,12 @@ tags:
     See the [Container Monitoring page](https://docs.datadoghq.com/containers/) for
     more information.
   name: Containers
-- description: Send events for DORA Metrics to measure and improve software delivery.
-    See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/) for more
-    information.
+- description: 'Search or send events for DORA Metrics to measure and improve your
+    software delivery performance. See the [DORA Metrics page](https://docs.datadoghq.com/dora_metrics/)
+    for more information.
+
+
+    **Note**: DORA Metrics are not available in the US1-FED site.'
   name: DORA Metrics
 - description: 'Interact with your dashboard lists through the API to
 

cassettes/v2/DORA-Metrics_482886860/Get-a-list-of-deployment-events-returns-Bad-Request-response_1700583315/frozen.json

@@ -0,0 +1 @@
+"2025-05-22T10:44:58.608Z"