Add PreviewCatalogEntities (#2757)

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

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

.generator/schemas/v2/openapi.yaml

@@ -17294,11 +17294,201 @@ components:
         schema:
           $ref: '#/components/schemas/EntityToSchema'
       type: object
+    EntityResponseArray:
+      properties:
+        data:
+          items:
+            $ref: '#/components/schemas/PreviewEntityResponseData'
+          type: array
+      required:
+      - data
+      type: object
     EntityResponseData:
       description: List of entity data.
       items:
         $ref: '#/components/schemas/EntityData'
       type: array
+    EntityResponseDataAttributes:
+      properties:
+        apiVersion:
+          type: string
+        description:
+          type: string
+        displayName:
+          type: string
+        kind:
+          type: string
+        name:
+          type: string
+        namespace:
+          type: string
+        owner:
+          type: string
+        properties:
+          additionalProperties: {}
+          type: object
+        tags:
+          items:
+            type: string
+          type: array
+      type: object
+    EntityResponseDataRelationships:
+      properties:
+        incidents:
+          $ref: '#/components/schemas/EntityResponseDataRelationshipsIncidents'
+        oncalls:
+          $ref: '#/components/schemas/EntityResponseDataRelationshipsOncalls'
+        rawSchema:
+          $ref: '#/components/schemas/EntityResponseDataRelationshipsRawSchema'
+        relatedEntities:
+          $ref: '#/components/schemas/EntityResponseDataRelationshipsRelatedEntities'
+        schema:
+          $ref: '#/components/schemas/EntityResponseDataRelationshipsSchema'
+      type: object
+    EntityResponseDataRelationshipsIncidents:
+      properties:
+        data:
+          items:
+            $ref: '#/components/schemas/EntityResponseDataRelationshipsIncidentsDataItems'
+          type: array
+      type: object
+    EntityResponseDataRelationshipsIncidentsDataItems:
+      properties:
+        id:
+          example: ''
+          type: string
+        type:
+          $ref: '#/components/schemas/EntityResponseDataRelationshipsIncidentsDataItemsType'
+      required:
+      - type
+      - id
+      type: object
+    EntityResponseDataRelationshipsIncidentsDataItemsType:
+      default: incident
+      description: Incident resource type.
+      enum:
+      - incident
+      example: incident
+      type: string
+      x-enum-varnames:
+      - INCIDENT
+    EntityResponseDataRelationshipsOncalls:
+      properties:
+        data:
+          items:
+            $ref: '#/components/schemas/EntityResponseDataRelationshipsOncallsDataItems'
+          type: array
+      type: object
+    EntityResponseDataRelationshipsOncallsDataItems:
+      properties:
+        id:
+          example: ''
+          type: string
+        type:
+          $ref: '#/components/schemas/EntityResponseDataRelationshipsOncallsDataItemsType'
+      required:
+      - type
+      - id
+      type: object
+    EntityResponseDataRelationshipsOncallsDataItemsType:
+      default: oncall
+      description: Oncall resource type.
+      enum:
+      - oncall
+      example: oncall
+      type: string
+      x-enum-varnames:
+      - ONCALL
+    EntityResponseDataRelationshipsRawSchema:
+      properties:
+        data:
+          $ref: '#/components/schemas/EntityResponseDataRelationshipsRawSchemaData'
+      required:
+      - data
+      type: object
+    EntityResponseDataRelationshipsRawSchemaData:
+      properties:
+        id:
+          example: ''
+          type: string
+        type:
+          $ref: '#/components/schemas/EntityResponseDataRelationshipsRawSchemaDataType'
+      required:
+      - type
+      - id
+      type: object
+    EntityResponseDataRelationshipsRawSchemaDataType:
+      default: rawSchema
+      description: Raw schema resource type.
+      enum:
+      - rawSchema
+      example: rawSchema
+      type: string
+      x-enum-varnames:
+      - RAWSCHEMA
+    EntityResponseDataRelationshipsRelatedEntities:
+      properties:
+        data:
+          items:
+            $ref: '#/components/schemas/EntityResponseDataRelationshipsRelatedEntitiesDataItems'
+          type: array
+      type: object
+    EntityResponseDataRelationshipsRelatedEntitiesDataItems:
+      properties:
+        id:
+          example: ''
+          type: string
+        type:
+          $ref: '#/components/schemas/EntityResponseDataRelationshipsRelatedEntitiesDataItemsType'
+      required:
+      - type
+      - id
+      type: object
+    EntityResponseDataRelationshipsRelatedEntitiesDataItemsType:
+      default: relatedEntity
+      description: Related entity resource type.
+      enum:
+      - relatedEntity
+      example: relatedEntity
+      type: string
+      x-enum-varnames:
+      - RELATEDENTITY
+    EntityResponseDataRelationshipsSchema:
+      properties:
+        data:
+          $ref: '#/components/schemas/EntityResponseDataRelationshipsSchemaData'
+      required:
+      - data
+      type: object
+    EntityResponseDataRelationshipsSchemaData:
+      properties:
+        id:
+          example: ''
+          type: string
+        type:
+          $ref: '#/components/schemas/EntityResponseDataRelationshipsSchemaDataType'
+      required:
+      - type
+      - id
+      type: object
+    EntityResponseDataRelationshipsSchemaDataType:
+      default: schema
+      description: Schema resource type.
+      enum:
+      - schema
+      example: schema
+      type: string
+      x-enum-varnames:
+      - SCHEMA
+    EntityResponseDataType:
+      default: entity
+      description: Entity resource type.
+      enum:
+      - entity
+      example: entity
+      type: string
+      x-enum-varnames:
+      - ENTITY
     EntityResponseIncludedIncident:
       description: Included incident.
       properties:
@@ -37681,6 +37871,19 @@ components:
           description: Offset type.
           type: string
       type: object
+    PreviewEntityResponseData:
+      properties:
+        attributes:
+          $ref: '#/components/schemas/EntityResponseDataAttributes'
+        id:
+          type: string
+        relationships:
+          $ref: '#/components/schemas/EntityResponseDataRelationships'
+        type:
+          $ref: '#/components/schemas/EntityResponseDataType'
+      required:
+      - type
+      type: object
     ProcessSummariesMeta:
       description: Response metadata object.
       properties:
@@ -58421,6 +58624,26 @@ paths:
       tags:
       - Software Catalog
       x-codegen-request-body-name: body
+  /api/v2/catalog/entity/preview:
+    post:
+      operationId: PreviewCatalogEntities
+      responses:
+        '202':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EntityResponseArray'
+          description: Accepted
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - apm_service_catalog_read
+      summary: Preview catalog entities
+      tags:
+      - Software Catalog
   /api/v2/catalog/entity/{entity_id}:
     delete:
       description: Delete a single entity in Software Catalog.

examples/v2/software-catalog/PreviewCatalogEntities.rb

@@ -0,0 +1,5 @@
+# Preview catalog entities returns "Accepted" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SoftwareCatalogAPI.new
+p api_instance.preview_catalog_entities()

features/v2/software_catalog.feature

@@ -144,3 +144,9 @@ Feature: Software Catalog
     And request contains "page[limit]" parameter with value 20
     When the request with pagination is sent
     Then the response status is 200 OK
+
+  @generated @skip @team:DataDog/service-catalog
+  Scenario: Preview catalog entities returns "Accepted" response
+    Given new "PreviewCatalogEntities" request
+    When the request is sent
+    Then the response status is 202 Accepted

features/v2/undo.json

@@ -751,6 +751,12 @@
       "type": "unsafe"
     }
   },
+  "PreviewCatalogEntities": {
+    "tag": "Software Catalog",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "DeleteCatalogEntity": {
     "tag": "Software Catalog",
     "undo": {

lib/datadog_api_client/inflector.rb

@@ -1954,6 +1954,25 @@ def overrides
           "v2.entity_data" => "EntityData",
           "v2.entity_meta" => "EntityMeta",
           "v2.entity_relationships" => "EntityRelationships",
+          "v2.entity_response_array" => "EntityResponseArray",
+          "v2.entity_response_data_attributes" => "EntityResponseDataAttributes",
+          "v2.entity_response_data_relationships" => "EntityResponseDataRelationships",
+          "v2.entity_response_data_relationships_incidents" => "EntityResponseDataRelationshipsIncidents",
+          "v2.entity_response_data_relationships_incidents_data_items" => "EntityResponseDataRelationshipsIncidentsDataItems",
+          "v2.entity_response_data_relationships_incidents_data_items_type" => "EntityResponseDataRelationshipsIncidentsDataItemsType",
+          "v2.entity_response_data_relationships_oncalls" => "EntityResponseDataRelationshipsOncalls",
+          "v2.entity_response_data_relationships_oncalls_data_items" => "EntityResponseDataRelationshipsOncallsDataItems",
+          "v2.entity_response_data_relationships_oncalls_data_items_type" => "EntityResponseDataRelationshipsOncallsDataItemsType",
+          "v2.entity_response_data_relationships_raw_schema" => "EntityResponseDataRelationshipsRawSchema",
+          "v2.entity_response_data_relationships_raw_schema_data" => "EntityResponseDataRelationshipsRawSchemaData",
+          "v2.entity_response_data_relationships_raw_schema_data_type" => "EntityResponseDataRelationshipsRawSchemaDataType",
+          "v2.entity_response_data_relationships_related_entities" => "EntityResponseDataRelationshipsRelatedEntities",
+          "v2.entity_response_data_relationships_related_entities_data_items" => "EntityResponseDataRelationshipsRelatedEntitiesDataItems",
+          "v2.entity_response_data_relationships_related_entities_data_items_type" => "EntityResponseDataRelationshipsRelatedEntitiesDataItemsType",
+          "v2.entity_response_data_relationships_schema" => "EntityResponseDataRelationshipsSchema",
+          "v2.entity_response_data_relationships_schema_data" => "EntityResponseDataRelationshipsSchemaData",
+          "v2.entity_response_data_relationships_schema_data_type" => "EntityResponseDataRelationshipsSchemaDataType",
+          "v2.entity_response_data_type" => "EntityResponseDataType",
           "v2.entity_response_included_incident" => "EntityResponseIncludedIncident",
           "v2.entity_response_included_incident_type" => "EntityResponseIncludedIncidentType",
           "v2.entity_response_included_oncall" => "EntityResponseIncludedOncall",
@@ -3291,6 +3310,7 @@ def overrides
           "v2.powerpacks_response_meta" => "PowerpacksResponseMeta",
           "v2.powerpacks_response_meta_pagination" => "PowerpacksResponseMetaPagination",
           "v2.powerpack_template_variable" => "PowerpackTemplateVariable",
+          "v2.preview_entity_response_data" => "PreviewEntityResponseData",
           "v2.process_summaries_meta" => "ProcessSummariesMeta",
           "v2.process_summaries_meta_page" => "ProcessSummariesMetaPage",
           "v2.process_summaries_response" => "ProcessSummariesResponse",

lib/datadog_api_client/v2/api/software_catalog_api.rb

@@ -452,6 +452,63 @@ def list_catalog_relation_with_pagination(opts = {})
         end
     end
 
+    # Preview catalog entities.
+    #
+    # @see #preview_catalog_entities_with_http_info
+    def preview_catalog_entities(opts = {})
+      data, _status_code, _headers = preview_catalog_entities_with_http_info(opts)
+      data
+    end
+
+    # Preview catalog entities.
+    # @param opts [Hash] the optional parameters
+    # @return [Array<(EntityResponseArray, Integer, Hash)>] EntityResponseArray data, response status code and response headers
+    def preview_catalog_entities_with_http_info(opts = {})
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SoftwareCatalogAPI.preview_catalog_entities ...'
+      end
+      # resource path
+      local_var_path = '/api/v2/catalog/entity/preview'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'EntityResponseArray'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
+
+      new_options = opts.merge(
+        :operation => :preview_catalog_entities,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SoftwareCatalogAPI#preview_catalog_entities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create or update entities.
     #
     # @see #upsert_catalog_entity_with_http_info