Add support for API management ListAPIs (#1648)

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.6",
-            "regenerated": "2024-06-11 09:38:21.368112",
-            "spec_repo_commit": "cee92551"
+            "regenerated": "2024-06-11 14:30:58.357339",
+            "spec_repo_commit": "71f2f0da"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-06-11 09:38:21.386389",
-            "spec_repo_commit": "cee92551"
+            "regenerated": "2024-06-11 14:30:58.375959",
+            "spec_repo_commit": "71f2f0da"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -10554,6 +10554,52 @@ components:
           description: Jira project key
           type: string
       type: object
+    ListAPIsResponse:
+      description: Response for `ListAPIs`.
+      properties:
+        data:
+          description: List of API items.
+          items:
+            $ref: '#/components/schemas/ListAPIsResponseData'
+          type: array
+        meta:
+          $ref: '#/components/schemas/ListAPIsResponseMeta'
+      type: object
+    ListAPIsResponseData:
+      description: Data envelope for `ListAPIsResponse`.
+      properties:
+        id:
+          $ref: '#/components/schemas/ApiID'
+        name:
+          description: API name.
+          example: Payments API
+          type: string
+      type: object
+    ListAPIsResponseMeta:
+      description: Metadata for `ListAPIsResponse`.
+      properties:
+        pagination:
+          $ref: '#/components/schemas/ListAPIsResponseMetaPagination'
+      type: object
+    ListAPIsResponseMetaPagination:
+      description: Pagination metadata information for `ListAPIsResponse`.
+      properties:
+        limit:
+          description: Number of items in the current page.
+          example: 20
+          format: int64
+          type: integer
+        offset:
+          description: Offset for pagination.
+          example: 0
+          format: int64
+          type: integer
+        total_count:
+          description: Total number of items.
+          example: 35
+          format: int64
+          type: integer
+      type: object
     ListApplicationKeysResponse:
       description: Response for a list of application keys.
       properties:
@@ -23350,6 +23396,63 @@ paths:
       tags:
       - Key Management
       x-codegen-request-body-name: body
+  /api/v2/apicatalog/api:
+    get:
+      description: List APIs and their IDs.
+      operationId: ListAPIs
+      parameters:
+      - description: Filter APIs by name
+        in: query
+        name: query
+        required: false
+        schema:
+          example: payments
+          type: string
+      - description: Number of items per page.
+        in: query
+        name: page[limit]
+        required: false
+        schema:
+          default: 20
+          format: int64
+          minimum: 1
+          type: integer
+      - description: Offset for pagination.
+        in: query
+        name: page[offset]
+        required: false
+        schema:
+          default: 0
+          format: int64
+          minimum: 0
+          type: integer
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ListAPIsResponse'
+          description: OK
+        '400':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
+          description: Bad request
+        '403':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/JSONAPIErrorResponse'
+          description: Forbidden
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      summary: List APIs
+      tags:
+      - API Management
+      x-unstable: '**Note**: This endpoint is in public beta.
+
+        If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
   /api/v2/apicatalog/api/{id}:
     delete:
       description: Delete a specific API by ID.

examples/v2/api-management/ListAPIs.ts

@@ -0,0 +1,18 @@
+/**
+ * List APIs returns "OK" response
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+configuration.unstableOperations["v2.listAPIs"] = true;
+const apiInstance = new v2.APIManagementApi(configuration);
+
+apiInstance
+  .listAPIs()
+  .then((data: v2.ListAPIsResponse) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/support/scenarios_model_mapping.ts

@@ -2472,6 +2472,21 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
             },
         "operationResponseType": "ApplicationKeyResponse",
     },
+    "v2.ListAPIs": {
+        "query": {
+            "type": "string",
+            "format": "",
+            },
+        "pageLimit": {
+            "type": "number",
+            "format": "int64",
+            },
+        "pageOffset": {
+            "type": "number",
+            "format": "int64",
+            },
+        "operationResponseType": "ListAPIsResponse",
+    },
     "v2.DeleteOpenAPI": {
         "id": {
             "type": "string",

features/v2/api_management.feature

@@ -73,6 +73,20 @@ Feature: API Management
     When the request is sent
     Then the response status is 200 OK
 
+  @generated @skip @team:DataDog/api-management
+  Scenario: List APIs returns "Bad request" response
+    Given operation "ListAPIs" enabled
+    And new "ListAPIs" request
+    When the request is sent
+    Then the response status is 400 Bad request
+
+  @generated @skip @team:DataDog/api-management
+  Scenario: List APIs returns "OK" response
+    Given operation "ListAPIs" enabled
+    And new "ListAPIs" request
+    When the request is sent
+    Then the response status is 200 OK
+
   @generated @skip @team:DataDog/api-management
   Scenario: Update an API returns "API not found error" response
     Given operation "UpdateOpenAPI" enabled

features/v2/undo.json

@@ -36,6 +36,12 @@
       "type": "idempotent"
     }
   },
+  "ListAPIs": {
+    "tag": "API Management",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "DeleteOpenAPI": {
     "tag": "API Management",
     "undo": {

packages/datadog-api-client-common/configuration.ts

@@ -217,6 +217,7 @@ export function createConfiguration(
       "v2.createOpenAPI": false,
       "v2.deleteOpenAPI": false,
       "v2.getOpenAPI": false,
+      "v2.listAPIs": false,
       "v2.updateOpenAPI": false,
       "v2.getActiveBillingDimensions": false,
       "v2.getMonthlyCostAttribution": false,