Add Support for Incident Management Search API (#927)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-01-05 16:38:45.065507",
-            "spec_repo_commit": "b786ccc6"
+            "regenerated": "2023-01-06 07:37:00.902912",
+            "spec_repo_commit": "fe3267e8"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-01-05 16:38:45.079319",
-            "spec_repo_commit": "b786ccc6"
+            "regenerated": "2023-01-06 07:37:00.915435",
+            "spec_repo_commit": "fe3267e8"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -197,6 +197,44 @@ components:
         items:
           $ref: '#/components/schemas/IncidentRelatedObject'
         type: array
+    IncidentSearchIncludeQueryParameter:
+      description: Specifies which types of related objects should be included in
+        the response.
+      in: query
+      name: include
+      required: false
+      schema:
+        $ref: '#/components/schemas/IncidentRelatedObject'
+    IncidentSearchQueryQueryParameter:
+      description: 'Specifies which incidents should be returned. After entering a
+        search query in your [Incidents page][1],
+
+        use the query parameter value in the URL of the page as the value for this
+        parameter.
+
+
+        The query can contain any number of incident facets joined by `ANDs`, along
+        with multiple values for each of
+
+        those facets joined by `OR`s, for instance: `query="state:active AND severity:(SEV-2
+        OR SEV-1)"`.
+
+
+        [1]: https://app.datadoghq.com/incidents'
+      explode: false
+      in: query
+      name: query
+      required: true
+      schema:
+        type: string
+    IncidentSearchSortQueryParameter:
+      description: Specifies the order of returned incidents.
+      explode: false
+      in: query
+      name: sort
+      required: false
+      schema:
+        $ref: '#/components/schemas/IncidentSearchSortOrder'
     IncidentServiceIDPathParameter:
       description: The ID of the incident service.
       in: path
@@ -4010,6 +4048,220 @@ components:
         last_modified_by_user:
           $ref: '#/components/schemas/RelationshipToUser'
       type: object
+    IncidentSearchResponse:
+      description: Response with incidents and facets.
+      properties:
+        data:
+          $ref: '#/components/schemas/IncidentSearchResponseData'
+        included:
+          description: Included related resources that the user requested.
+          items:
+            $ref: '#/components/schemas/IncidentResponseIncludedItem'
+          readOnly: true
+          type: array
+      required:
+      - data
+      type: object
+    IncidentSearchResponseAttributes:
+      description: Attributes returned by an incident search.
+      properties:
+        facets:
+          $ref: '#/components/schemas/IncidentSearchResponseFacetsData'
+        incidents:
+          description: Incidents returned by the search.
+          items:
+            $ref: '#/components/schemas/IncidentSearchResponseIncidentsData'
+          type: array
+        total:
+          description: Number of incidents returned by the search.
+          example: 10
+          format: int32
+          maximum: 2147483647
+          type: integer
+      required:
+      - facets
+      - incidents
+      - total
+      type: object
+    IncidentSearchResponseData:
+      description: Data returned by an incident search.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/IncidentSearchResponseAttributes'
+        type:
+          $ref: '#/components/schemas/IncidentSearchResultsType'
+      type: object
+    IncidentSearchResponseFacetCount:
+      description: Count of the facet value appearing in search results.
+      example: 5
+      format: int32
+      maximum: 2147483647
+      type: integer
+    IncidentSearchResponseFacetsData:
+      description: Facet data for incidents returned by a search query.
+      properties:
+        commander:
+          description: Facet data for incident commander users.
+          items:
+            $ref: '#/components/schemas/IncidentSearchResponseUserFacetData'
+          type: array
+        created_by:
+          description: Facet data for incident creator users.
+          items:
+            $ref: '#/components/schemas/IncidentSearchResponseUserFacetData'
+          type: array
+        fields:
+          description: Facet data for incident property fields.
+          items:
+            $ref: '#/components/schemas/IncidentSearchResponsePropertyFieldFacetData'
+          type: array
+        impact:
+          description: Facet data for incident impact attributes.
+          items:
+            $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData'
+          type: array
+        last_modified_by:
+          description: Facet data for incident last modified by users.
+          items:
+            $ref: '#/components/schemas/IncidentSearchResponseUserFacetData'
+          type: array
+        postmortem:
+          description: Facet data for incident postmortem existence.
+          items:
+            $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData'
+          type: array
+        responder:
+          description: Facet data for incident responder users.
+          items:
+            $ref: '#/components/schemas/IncidentSearchResponseUserFacetData'
+          type: array
+        severity:
+          description: Facet data for incident severity attributes.
+          items:
+            $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData'
+          type: array
+        state:
+          description: Facet data for incident state attributes.
+          items:
+            $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData'
+          type: array
+        time_to_repair:
+          description: Facet data for incident time to repair metrics.
+          items:
+            $ref: '#/components/schemas/IncidentSearchResponseNumericFacetData'
+          type: array
+        time_to_resolve:
+          description: Facet data for incident time to resolve metrics.
+          items:
+            $ref: '#/components/schemas/IncidentSearchResponseNumericFacetData'
+          type: array
+      type: object
+    IncidentSearchResponseFieldFacetData:
+      description: Facet value and number of occurrences for a property field of an
+        incident.
+      properties:
+        count:
+          $ref: '#/components/schemas/IncidentSearchResponseFacetCount'
+        name:
+          description: The facet value appearing in search results.
+          example: SEV-2
+          type: string
+      type: object
+    IncidentSearchResponseIncidentsData:
+      description: Incident returned by the search.
+      properties:
+        data:
+          $ref: '#/components/schemas/IncidentResponseData'
+      required:
+      - data
+      type: object
+    IncidentSearchResponseNumericFacetData:
+      description: Facet data numeric attributes of an incident.
+      properties:
+        aggregates:
+          $ref: '#/components/schemas/IncidentSearchResponseNumericFacetDataAggregates'
+        name:
+          description: Name of the incident property field.
+          example: time_to_repair
+          type: string
+      required:
+      - name
+      - aggregates
+      type: object
+    IncidentSearchResponseNumericFacetDataAggregates:
+      description: Aggregate information for numeric incident data.
+      properties:
+        max:
+          description: Maximum value of the numeric aggregates.
+          example: 1234.0
+          format: double
+          nullable: true
+          type: number
+        min:
+          description: Minimum value of the numeric aggregates.
+          example: 20.0
+          format: double
+          nullable: true
+          type: number
+      type: object
+    IncidentSearchResponsePropertyFieldFacetData:
+      description: Facet data for the incident property fields.
+      properties:
+        aggregates:
+          $ref: '#/components/schemas/IncidentSearchResponseNumericFacetDataAggregates'
+        facets:
+          description: Facet data for the property field of an incident.
+          items:
+            $ref: '#/components/schemas/IncidentSearchResponseFieldFacetData'
+          type: array
+        name:
+          description: Name of the incident property field.
+          example: Severity
+          type: string
+      required:
+      - facets
+      - name
+      type: object
+    IncidentSearchResponseUserFacetData:
+      description: Facet data for user attributes of an incident.
+      properties:
+        count:
+          $ref: '#/components/schemas/IncidentSearchResponseFacetCount'
+        email:
+          description: Email of the user.
+          example: [email protected]
+          type: string
+        handle:
+          description: Handle of the user.
+          example: '@[email protected]'
+          type: string
+        name:
+          description: Name of the user.
+          example: Datadog User
+          type: string
+        uuid:
+          description: ID of the user.
+          example: 773b045d-ccf8-4808-bd3b-955ef6a8c940
+          type: string
+      type: object
+    IncidentSearchResultsType:
+      default: incidents_search_results
+      description: Incident search result type.
+      enum:
+      - incidents_search_results
+      example: incidents_search_results
+      type: string
+      x-enum-varnames:
+      - INCIDENTS_SEARCH_RESULTS
+    IncidentSearchSortOrder:
+      description: The ways searched incidents can be sorted.
+      enum:
+      - created
+      - -created
+      type: string
+      x-enum-varnames:
+      - CREATED_ASCENDING
+      - CREATED_DESCENDING
     IncidentServiceCreateAttributes:
       description: The incident service's attributes for a create request.
       properties:
@@ -13185,6 +13437,42 @@ 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/incidents/search:
+    get:
+      description: Search for incidents matching a certain query.
+      operationId: SearchIncidents
+      parameters:
+      - $ref: '#/components/parameters/IncidentSearchIncludeQueryParameter'
+      - $ref: '#/components/parameters/IncidentSearchQueryQueryParameter'
+      - $ref: '#/components/parameters/IncidentSearchSortQueryParameter'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/IncidentSearchResponse'
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '401':
+          $ref: '#/components/responses/UnauthorizedResponse'
+        '403':
+          $ref: '#/components/responses/ForbiddenResponse'
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - incident_read
+      summary: Search for incidents
+      tags:
+      - Incidents
+      x-unstable: '**Note**: This endpoint is in public beta.
+
+        If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
   /api/v2/incidents/{incident_id}:
     delete:
       description: Deletes an existing incident from the users organization.

cassettes/v2/Incidents_2863714588/Search-for-incidents-returns-OK-response_1082852563/frozen.json

@@ -0,0 +1 @@
+"2023-01-04T00:33:33.944Z"