Add a new endpoint for listing Software Catalog relations (#2361)

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 14:41:17.269012",
-            "spec_repo_commit": "a4ecd4cf"
+            "regenerated": "2025-05-23 16:55:08.805844",
+            "spec_repo_commit": "6a0ddfd8"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-05-23 14:41:17.286736",
-            "spec_repo_commit": "a4ecd4cf"
+            "regenerated": "2025-05-23 16:55:08.821917",
+            "spec_repo_commit": "6a0ddfd8"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -351,6 +351,7 @@ components:
         type: string
     FilterByRef:
       description: Filter entities by reference
+      example: service:shopping-cart
       explode: true
       in: query
       name: filter[ref]
@@ -365,6 +366,32 @@ components:
       required: false
       schema:
         $ref: '#/components/schemas/RelationType'
+    FilterRelationByFromRef:
+      description: Filter relations by the reference of the first entity in the relation.
+      example: service:shopping-cart
+      explode: true
+      in: query
+      name: filter[from_ref]
+      required: false
+      schema:
+        type: string
+    FilterRelationByToRef:
+      description: Filter relations by the reference of the second entity in the relation.
+      example: service:shopping-cart
+      explode: true
+      in: query
+      name: filter[to_ref]
+      required: false
+      schema:
+        type: string
+    FilterRelationByType:
+      description: Filter relations by type.
+      explode: true
+      in: query
+      name: filter[type]
+      required: false
+      schema:
+        $ref: '#/components/schemas/RelationType'
     GCPSTSServiceAccountID:
       description: Your GCP STS enabled service account's unique ID.
       in: path
@@ -675,6 +702,14 @@ components:
       required: true
       schema:
         type: string
+    RelationInclude:
+      description: Include relationship data.
+      explode: true
+      in: query
+      name: include
+      required: false
+      schema:
+        $ref: '#/components/schemas/RelationIncludeType'
     ReportID:
       description: The ID of the report job.
       in: path
@@ -19491,6 +19526,38 @@ components:
         meta:
           $ref: '#/components/schemas/PowerpacksResponseMeta'
       type: object
+    ListRelationCatalogResponse:
+      description: List entity relation response.
+      properties:
+        data:
+          $ref: '#/components/schemas/RelationResponseData'
+        included:
+          $ref: '#/components/schemas/ListRelationCatalogResponseIncluded'
+        links:
+          $ref: '#/components/schemas/ListRelationCatalogResponseLinks'
+        meta:
+          $ref: '#/components/schemas/RelationResponseMeta'
+      type: object
+    ListRelationCatalogResponseIncluded:
+      description: List relation response included entities.
+      items:
+        $ref: '#/components/schemas/EntityData'
+      type: array
+    ListRelationCatalogResponseLinks:
+      description: List relation response links.
+      properties:
+        next:
+          description: Next link.
+          example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=2
+          type: string
+        previous:
+          description: Previous link.
+          type: string
+        self:
+          description: Current link.
+          example: /api/v2/catalog/relation?filter[from_ref]=service:service-catalog&include=entity&page[limit]=2&page[offset]=0
+          type: string
+      type: object
     ListRulesResponse:
       description: Scorecard rules response.
       properties:
@@ -28773,6 +28840,114 @@ components:
       x-enum-varnames:
       - ANY
       - ALL
+    RelationAttributes:
+      description: Relation attributes.
+      properties:
+        from:
+          $ref: '#/components/schemas/RelationEntity'
+        to:
+          $ref: '#/components/schemas/RelationEntity'
+        type:
+          $ref: '#/components/schemas/RelationType'
+      type: object
+    RelationEntity:
+      description: Relation entity reference.
+      properties:
+        kind:
+          description: Entity kind.
+          type: string
+        name:
+          description: Entity name.
+          type: string
+        namespace:
+          description: Entity namespace.
+          type: string
+      type: object
+    RelationIncludeType:
+      description: Supported include types for relations.
+      enum:
+      - entity
+      - schema
+      type: string
+      x-enum-varnames:
+      - ENTITY
+      - SCHEMA
+    RelationMeta:
+      description: Relation metadata.
+      properties:
+        createdAt:
+          description: Relation creation time.
+          format: date-time
+          type: string
+        definedBy:
+          description: Relation defined by.
+          type: string
+        modifiedAt:
+          description: Relation modification time.
+          format: date-time
+          type: string
+        source:
+          description: Relation source.
+          type: string
+      type: object
+    RelationRelationships:
+      description: Relation relationships.
+      properties:
+        fromEntity:
+          $ref: '#/components/schemas/RelationToEntity'
+        toEntity:
+          $ref: '#/components/schemas/RelationToEntity'
+      type: object
+    RelationResponse:
+      description: Relation response data.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/RelationAttributes'
+        id:
+          description: Relation ID.
+          type: string
+        meta:
+          $ref: '#/components/schemas/RelationMeta'
+        relationships:
+          $ref: '#/components/schemas/RelationRelationships'
+        subtype:
+          description: Relation subtype.
+          type: string
+        type:
+          $ref: '#/components/schemas/RelationResponseType'
+      type: object
+    RelationResponseData:
+      description: Array of relation responses
+      items:
+        $ref: '#/components/schemas/RelationResponse'
+      type: array
+    RelationResponseMeta:
+      description: Relation response metadata.
+      properties:
+        count:
+          description: Total relations count.
+          format: int64
+          type: integer
+        includeCount:
+          description: Total included data count.
+          format: int64
+          type: integer
+      type: object
+    RelationResponseType:
+      description: Relation type.
+      enum:
+      - relation
+      type: string
+      x-enum-varnames:
+      - RELATION
+    RelationToEntity:
+      description: Relation to entity.
+      properties:
+        data:
+          $ref: '#/components/schemas/RelationshipItem'
+        meta:
+          $ref: '#/components/schemas/EntityMeta'
+      type: object
     RelationType:
       description: Supported relation types.
       enum:
@@ -43187,6 +43362,48 @@ paths:
       summary: Delete a single entity
       tags:
       - Software Catalog
+  /api/v2/catalog/relation:
+    get:
+      description: Get a list of entity relations from Software Catalog.
+      operationId: ListCatalogRelation
+      parameters:
+      - $ref: '#/components/parameters/PageOffset'
+      - description: Maximum number of relations in the response.
+        example: 100
+        in: query
+        name: page[limit]
+        required: false
+        schema:
+          default: 100
+          format: int64
+          type: integer
+      - $ref: '#/components/parameters/FilterRelationByType'
+      - $ref: '#/components/parameters/FilterRelationByFromRef'
+      - $ref: '#/components/parameters/FilterRelationByToRef'
+      - $ref: '#/components/parameters/RelationInclude'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ListRelationCatalogResponse'
+          description: OK
+        '403':
+          $ref: '#/components/responses/ForbiddenResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - apm_service_catalog_read
+      summary: Get a list of entity relations
+      tags:
+      - Software Catalog
+      x-pagination:
+        limitParam: page[limit]
+        pageOffsetParam: page[offset]
+        resultsPath: data
   /api/v2/ci/pipeline:
     post:
       description: 'Send your pipeline event to your Datadog platform over HTTP. For

cassettes/features/v2/software_catalog/Get-a-list-of-entity-relations-returns-OK-response-with-pagination.frozen

@@ -0,0 +1 @@
+2025-05-23T14:58:05.829Z

cassettes/features/v2/software_catalog/Get-a-list-of-entity-relations-returns-OK-response-with-pagination.yml

@@ -0,0 +1 @@
+2025-05-23T13:41:46.286Z

cassettes/features/v2/software_catalog/Get-a-list-of-entity-relations-returns-OK-response.frozen

@@ -0,0 +1,5 @@
+# Get a list of entity relations returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SoftwareCatalogAPI.new
+p api_instance.list_catalog_relation()

cassettes/features/v2/software_catalog/Get-a-list-of-entity-relations-returns-OK-response.yml

@@ -0,0 +1,8 @@
+# Get a list of entity relations returns "OK" response with pagination
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SoftwareCatalogAPI.new
+opts = {
+  page_limit: 20,
+}
+api_instance.list_catalog_relation_with_pagination(opts) { |item| puts item }

examples/v2/software-catalog/ListCatalogRelation.rb

@@ -1106,6 +1106,14 @@
     "v2.DeleteCatalogEntity" => {
             "entity_id" => "String",
     },
+    "v2.ListCatalogRelation" => {
+            "page_offset" => "Integer",
+            "page_limit" => "Integer",
+            "filter_type" => "RelationType",
+            "filter_from_ref" => "String",
+            "filter_to_ref" => "String",
+            "include" => "RelationIncludeType",
+    },
     "v2.CreateCIAppPipelineEvent" => {
             "body" => "CIAppCreatePipelineEventRequest",
     },

examples/v2/software-catalog/ListCatalogRelation_1311054087.rb

@@ -78,3 +78,16 @@ Feature: Software Catalog
     Given new "ListCatalogEntity" request
     When the request with pagination is sent
     Then the response status is 200 OK
+
+  @replay-only @team:DataDog/service-catalog
+  Scenario: Get a list of entity relations returns "OK" response
+    Given new "ListCatalogRelation" request
+    When the request is sent
+    Then the response status is 200 OK
+
+  @replay-only @skip-validation @team:DataDog/service-catalog @with-pagination
+  Scenario: Get a list of entity relations returns "OK" response with pagination
+    Given new "ListCatalogRelation" request
+    And request contains "page[limit]" parameter with value 20
+    When the request with pagination is sent
+    Then the response status is 200 OK