Add new endpoint to upsert/list/delete custom kinds (#2892)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-06-06 14:53:22.185897",
-            "spec_repo_commit": "e591d5d4"
+            "regenerated": "2025-06-06 17:43:33.552338",
+            "spec_repo_commit": "01341d5b"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-06-06 14:53:22.203481",
-            "spec_repo_commit": "e591d5d4"
+            "regenerated": "2025-06-06 17:43:33.567997",
+            "spec_repo_commit": "01341d5b"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -563,6 +563,14 @@ components:
       required: true
       schema:
         type: string
+    KindID:
+      description: Entity kind.
+      in: path
+      name: kind_id
+      required: true
+      schema:
+        example: my-job
+        type: string
     MetricID:
       description: The name of the log-based metric.
       in: path
@@ -19303,6 +19311,90 @@ components:
       - index
       - caseIndex
       type: object
+    KindAttributes:
+      description: Kind attributes.
+      properties:
+        description:
+          description: Short description of the kind.
+          type: string
+        displayName:
+          description: User friendly name of the kind.
+          type: string
+        name:
+          description: The kind name.
+          example: my-job
+          minLength: 1
+          type: string
+      type: object
+    KindData:
+      description: Schema that defines the structure of a Kind object in the Software
+        Catalog.
+      properties:
+        attributes:
+          $ref: '#/components/schemas/KindAttributes'
+        id:
+          description: A read-only globally unique identifier for the entity generated
+            by Datadog.  User supplied values are ignored.
+          example: 4b163705-23c0-4573-b2fb-f6cea2163fcb
+          minLength: 1
+          type: string
+        meta:
+          $ref: '#/components/schemas/KindMetadata'
+        type:
+          description: Kind.
+          type: string
+      type: object
+    KindMetadata:
+      description: Kind metadata.
+      properties:
+        createdAt:
+          description: The creation time.
+          type: string
+        modifiedAt:
+          description: The modification time.
+          type: string
+      type: object
+    KindObj:
+      description: Schema for kind.
+      properties:
+        description:
+          description: Short description of the kind.
+          type: string
+        displayName:
+          description: The display name of the kind. Automatically generated if not
+            provided.
+          type: string
+        kind:
+          description: The name of the kind to create or update. This must be in kebab-case
+            format.
+          example: my-job
+          type: string
+      required:
+      - kind
+      type: object
+    KindRaw:
+      description: Kind definition in raw JSON or YAML representation.
+      example: 'kind: service
+
+        displayName: Service
+
+        description: A service entity in the catalog.
+
+        '
+      type: string
+    KindResponseData:
+      description: List of kind responses.
+      items:
+        $ref: '#/components/schemas/KindData'
+      type: array
+    KindResponseMeta:
+      description: Kind response metadata.
+      properties:
+        count:
+          description: Total kinds count.
+          format: int64
+          type: integer
+      type: object
     Layer:
       description: Encapsulates a layer resource, holding attributes like rotation
         details, plus relationships to the members covering that layer.
@@ -19789,6 +19881,14 @@ components:
         meta:
           $ref: '#/components/schemas/HistoricalJobListMeta'
       type: object
+    ListKindCatalogResponse:
+      description: List kind response.
+      properties:
+        data:
+          $ref: '#/components/schemas/KindResponseData'
+        meta:
+          $ref: '#/components/schemas/KindResponseMeta'
+      type: object
     ListPipelinesResponse:
       description: Represents the response payload containing a list of pipelines
         and associated metadata.
@@ -39531,6 +39631,19 @@ components:
       description: Upsert entity response included item.
       oneOf:
       - $ref: '#/components/schemas/EntityResponseIncludedSchema'
+    UpsertCatalogKindRequest:
+      description: Create or update kind request.
+      oneOf:
+      - $ref: '#/components/schemas/KindObj'
+      - $ref: '#/components/schemas/KindRaw'
+    UpsertCatalogKindResponse:
+      description: Upsert kind response.
+      properties:
+        data:
+          $ref: '#/components/schemas/KindResponseData'
+        meta:
+          $ref: '#/components/schemas/KindResponseMeta'
+      type: object
     Urgency:
       description: Specifies the level of urgency for a routing rule (low, high, or
         dynamic).
@@ -43768,6 +43881,105 @@ paths:
       summary: Delete a single entity
       tags:
       - Software Catalog
+  /api/v2/catalog/kind:
+    get:
+      description: Get a list of entity kinds from Software Catalog.
+      operationId: ListCatalogKind
+      parameters:
+      - $ref: '#/components/parameters/PageOffset'
+      - description: Maximum number of kinds in the response.
+        example: 100
+        in: query
+        name: page[limit]
+        required: false
+        schema:
+          default: 100
+          format: int64
+          type: integer
+      - $ref: '#/components/parameters/FilterByID'
+      - $ref: '#/components/parameters/FilterByName'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ListKindCatalogResponse'
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/ForbiddenResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - apm_service_catalog_read
+      summary: Get a list of entity kinds
+      tags:
+      - Software Catalog
+      x-pagination:
+        limitParam: page[limit]
+        pageOffsetParam: page[offset]
+        resultsPath: data
+    post:
+      description: Create or update kinds in Software Catalog.
+      operationId: UpsertCatalogKind
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UpsertCatalogKindRequest'
+        description: Kind YAML or JSON.
+        required: true
+      responses:
+        '202':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UpsertCatalogKindResponse'
+          description: ACCEPTED
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/ForbiddenResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - apm_service_catalog_write
+      summary: Create or update kinds
+      tags:
+      - Software Catalog
+      x-codegen-request-body-name: body
+  /api/v2/catalog/kind/{kind_id}:
+    delete:
+      description: Delete a single kind in Software Catalog.
+      operationId: DeleteCatalogKind
+      parameters:
+      - $ref: '#/components/parameters/KindID'
+      responses:
+        '204':
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/ForbiddenResponse'
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - apm_service_catalog_write
+      summary: Delete a single kind
+      tags:
+      - Software Catalog
   /api/v2/catalog/relation:
     get:
       description: Get a list of entity relations from Software Catalog.

examples/v2/software-catalog/DeleteCatalogKind.java

@@ -0,0 +1,22 @@
+// Delete a single kind returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.SoftwareCatalogApi;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    SoftwareCatalogApi apiInstance = new SoftwareCatalogApi(defaultClient);
+
+    try {
+      apiInstance.deleteCatalogKind("my-job");
+    } catch (ApiException e) {
+      System.err.println("Exception when calling SoftwareCatalogApi#deleteCatalogKind");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/software-catalog/ListCatalogKind.java

@@ -0,0 +1,24 @@
+// Get a list of entity kinds returns "OK" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.SoftwareCatalogApi;
+import com.datadog.api.client.v2.model.ListKindCatalogResponse;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    SoftwareCatalogApi apiInstance = new SoftwareCatalogApi(defaultClient);
+
+    try {
+      ListKindCatalogResponse result = apiInstance.listCatalogKind();
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling SoftwareCatalogApi#listCatalogKind");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/software-catalog/ListCatalogKind_3806205775.java

@@ -0,0 +1,25 @@
+// Get a list of entity kinds returns "OK" response with pagination
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.PaginationIterable;
+import com.datadog.api.client.v2.api.SoftwareCatalogApi;
+import com.datadog.api.client.v2.model.KindData;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    SoftwareCatalogApi apiInstance = new SoftwareCatalogApi(defaultClient);
+
+    try {
+      PaginationIterable<KindData> iterable = apiInstance.listCatalogKindWithPagination();
+
+      for (KindData item : iterable) {
+        System.out.println(item);
+      }
+    } catch (RuntimeException e) {
+      System.err.println("Exception when calling SoftwareCatalogApi#listCatalogKindWithPagination");
+      System.err.println("Reason: " + e.getMessage());
+      e.printStackTrace();
+    }
+  }
+}

examples/v2/software-catalog/UpsertCatalogKind.java

@@ -0,0 +1,28 @@
+// Create or update kinds returns "ACCEPTED" response
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.ApiException;
+import com.datadog.api.client.v2.api.SoftwareCatalogApi;
+import com.datadog.api.client.v2.model.KindObj;
+import com.datadog.api.client.v2.model.UpsertCatalogKindRequest;
+import com.datadog.api.client.v2.model.UpsertCatalogKindResponse;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    SoftwareCatalogApi apiInstance = new SoftwareCatalogApi(defaultClient);
+
+    UpsertCatalogKindRequest body = new UpsertCatalogKindRequest(new KindObj().kind("my-job"));
+
+    try {
+      UpsertCatalogKindResponse result = apiInstance.upsertCatalogKind(body);
+      System.out.println(result);
+    } catch (ApiException e) {
+      System.err.println("Exception when calling SoftwareCatalogApi#upsertCatalogKind");
+      System.err.println("Status code: " + e.getCode());
+      System.err.println("Reason: " + e.getResponseBody());
+      System.err.println("Response headers: " + e.getResponseHeaders());
+      e.printStackTrace();
+    }
+  }
+}