Document new api/app key schemas (#1405)

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": "2023-11-17 12:18:19.958601",
-            "spec_repo_commit": "d2efeed9"
+            "regenerated": "2023-11-17 18:13:28.852661",
+            "spec_repo_commit": "46090fc1"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-11-17 12:18:19.974563",
-            "spec_repo_commit": "d2efeed9"
+            "regenerated": "2023-11-17 18:13:28.867274",
+            "spec_repo_commit": "46090fc1"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -689,6 +689,26 @@ components:
           items:
             $ref: '#/components/schemas/APIKeyResponseIncludedItem'
           type: array
+        meta:
+          $ref: '#/components/schemas/APIKeysResponseMeta'
+      type: object
+    APIKeysResponseMeta:
+      description: Additional information related to api keys response.
+      properties:
+        max_allowed:
+          description: Max allowed number of API keys.
+          format: int64
+          type: integer
+        page:
+          $ref: '#/components/schemas/APIKeysResponseMetaPage'
+      type: object
+    APIKeysResponseMetaPage:
+      description: Additional information related to the API keys response.
+      properties:
+        total_filtered_count:
+          description: Total filtered application key count.
+          format: int64
+          type: integer
       type: object
     APIKeysSort:
       default: name
@@ -833,6 +853,24 @@ components:
       oneOf:
       - $ref: '#/components/schemas/User'
       - $ref: '#/components/schemas/Role'
+    ApplicationKeyResponseMeta:
+      description: Additional information related to the application key response.
+      properties:
+        max_allowed_per_user:
+          description: Max allowed number of application keys per user.
+          format: int64
+          type: integer
+        page:
+          $ref: '#/components/schemas/ApplicationKeyResponseMetaPage'
+      type: object
+    ApplicationKeyResponseMetaPage:
+      description: Additional information related to the application key response.
+      properties:
+        total_filtered_count:
+          description: Total filtered application key count.
+          format: int64
+          type: integer
+      type: object
     ApplicationKeyUpdateAttributes:
       description: Attributes used to update an application Key.
       properties:
@@ -8667,6 +8705,8 @@ components:
           items:
             $ref: '#/components/schemas/ApplicationKeyResponseIncludedItem'
           type: array
+        meta:
+          $ref: '#/components/schemas/ApplicationKeyResponseMeta'
       type: object
     ListDowntimesResponse:
       description: Response for retrieving all downtimes.

packages/datadog-api-client-v2/index.ts

@@ -444,6 +444,8 @@ export { APIKeyRelationships } from "./models/APIKeyRelationships";
 export { APIKeyResponse } from "./models/APIKeyResponse";
 export { APIKeyResponseIncludedItem } from "./models/APIKeyResponseIncludedItem";
 export { APIKeysResponse } from "./models/APIKeysResponse";
+export { APIKeysResponseMeta } from "./models/APIKeysResponseMeta";
+export { APIKeysResponseMetaPage } from "./models/APIKeysResponseMetaPage";
 export { APIKeysSort } from "./models/APIKeysSort";
 export { APIKeysType } from "./models/APIKeysType";
 export { APIKeyUpdateAttributes } from "./models/APIKeyUpdateAttributes";
@@ -456,6 +458,8 @@ export { ApplicationKeyCreateRequest } from "./models/ApplicationKeyCreateReques
 export { ApplicationKeyRelationships } from "./models/ApplicationKeyRelationships";
 export { ApplicationKeyResponse } from "./models/ApplicationKeyResponse";
 export { ApplicationKeyResponseIncludedItem } from "./models/ApplicationKeyResponseIncludedItem";
+export { ApplicationKeyResponseMeta } from "./models/ApplicationKeyResponseMeta";
+export { ApplicationKeyResponseMetaPage } from "./models/ApplicationKeyResponseMetaPage";
 export { ApplicationKeysSort } from "./models/ApplicationKeysSort";
 export { ApplicationKeysType } from "./models/ApplicationKeysType";
 export { ApplicationKeyUpdateAttributes } from "./models/ApplicationKeyUpdateAttributes";

packages/datadog-api-client-v2/models/APIKeysResponse.ts

@@ -4,6 +4,7 @@
  * Copyright 2020-Present Datadog, Inc.
  */
 import { APIKeyResponseIncludedItem } from "./APIKeyResponseIncludedItem";
+import { APIKeysResponseMeta } from "./APIKeysResponseMeta";
 import { PartialAPIKey } from "./PartialAPIKey";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
@@ -20,6 +21,10 @@ export class APIKeysResponse {
    * Array of objects related to the API key.
    */
   "included"?: Array<APIKeyResponseIncludedItem>;
+  /**
+   * Additional information related to api keys response.
+   */
+  "meta"?: APIKeysResponseMeta;
 
   /**
    * @ignore
@@ -38,6 +43,10 @@ export class APIKeysResponse {
       baseName: "included",
       type: "Array<APIKeyResponseIncludedItem>",
     },
+    meta: {
+      baseName: "meta",
+      type: "APIKeysResponseMeta",
+    },
   };
 
   /**

packages/datadog-api-client-v2/models/APIKeysResponseMeta.ts

@@ -0,0 +1,51 @@
+/**
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2020-Present Datadog, Inc.
+ */
+import { APIKeysResponseMetaPage } from "./APIKeysResponseMetaPage";
+
+import { AttributeTypeMap } from "../../datadog-api-client-common/util";
+
+/**
+ * Additional information related to api keys response.
+ */
+export class APIKeysResponseMeta {
+  /**
+   * Max allowed number of API keys.
+   */
+  "maxAllowed"?: number;
+  /**
+   * Additional information related to the API keys response.
+   */
+  "page"?: APIKeysResponseMetaPage;
+
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    maxAllowed: {
+      baseName: "max_allowed",
+      type: "number",
+      format: "int64",
+    },
+    page: {
+      baseName: "page",
+      type: "APIKeysResponseMetaPage",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return APIKeysResponseMeta.attributeTypeMap;
+  }
+
+  public constructor() {}
+}

packages/datadog-api-client-v2/models/APIKeysResponseMetaPage.ts

@@ -0,0 +1,42 @@
+/**
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2020-Present Datadog, Inc.
+ */
+
+import { AttributeTypeMap } from "../../datadog-api-client-common/util";
+
+/**
+ * Additional information related to the API keys response.
+ */
+export class APIKeysResponseMetaPage {
+  /**
+   * Total filtered application key count.
+   */
+  "totalFilteredCount"?: number;
+
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    totalFilteredCount: {
+      baseName: "total_filtered_count",
+      type: "number",
+      format: "int64",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return APIKeysResponseMetaPage.attributeTypeMap;
+  }
+
+  public constructor() {}
+}

packages/datadog-api-client-v2/models/ApplicationKeyResponseMeta.ts

@@ -0,0 +1,51 @@
+/**
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2020-Present Datadog, Inc.
+ */
+import { ApplicationKeyResponseMetaPage } from "./ApplicationKeyResponseMetaPage";
+
+import { AttributeTypeMap } from "../../datadog-api-client-common/util";
+
+/**
+ * Additional information related to the application key response.
+ */
+export class ApplicationKeyResponseMeta {
+  /**
+   * Max allowed number of application keys per user.
+   */
+  "maxAllowedPerUser"?: number;
+  /**
+   * Additional information related to the application key response.
+   */
+  "page"?: ApplicationKeyResponseMetaPage;
+
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    maxAllowedPerUser: {
+      baseName: "max_allowed_per_user",
+      type: "number",
+      format: "int64",
+    },
+    page: {
+      baseName: "page",
+      type: "ApplicationKeyResponseMetaPage",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return ApplicationKeyResponseMeta.attributeTypeMap;
+  }
+
+  public constructor() {}
+}

packages/datadog-api-client-v2/models/ApplicationKeyResponseMetaPage.ts

@@ -0,0 +1,42 @@
+/**
+ * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ * This product includes software developed at Datadog (https://www.datadoghq.com/).
+ * Copyright 2020-Present Datadog, Inc.
+ */
+
+import { AttributeTypeMap } from "../../datadog-api-client-common/util";
+
+/**
+ * Additional information related to the application key response.
+ */
+export class ApplicationKeyResponseMetaPage {
+  /**
+   * Total filtered application key count.
+   */
+  "totalFilteredCount"?: number;
+
+  /**
+   * @ignore
+   */
+  "_unparsed"?: boolean;
+
+  /**
+   * @ignore
+   */
+  static readonly attributeTypeMap: AttributeTypeMap = {
+    totalFilteredCount: {
+      baseName: "total_filtered_count",
+      type: "number",
+      format: "int64",
+    },
+  };
+
+  /**
+   * @ignore
+   */
+  static getAttributeTypeMap(): AttributeTypeMap {
+    return ApplicationKeyResponseMetaPage.attributeTypeMap;
+  }
+
+  public constructor() {}
+}

packages/datadog-api-client-v2/models/ListApplicationKeysResponse.ts

@@ -4,6 +4,7 @@
  * Copyright 2020-Present Datadog, Inc.
  */
 import { ApplicationKeyResponseIncludedItem } from "./ApplicationKeyResponseIncludedItem";
+import { ApplicationKeyResponseMeta } from "./ApplicationKeyResponseMeta";
 import { PartialApplicationKey } from "./PartialApplicationKey";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
@@ -20,6 +21,10 @@ export class ListApplicationKeysResponse {
    * Array of objects related to the application key.
    */
   "included"?: Array<ApplicationKeyResponseIncludedItem>;
+  /**
+   * Additional information related to the application key response.
+   */
+  "meta"?: ApplicationKeyResponseMeta;
 
   /**
    * @ignore
@@ -38,6 +43,10 @@ export class ListApplicationKeysResponse {
       baseName: "included",
       type: "Array<ApplicationKeyResponseIncludedItem>",
     },
+    meta: {
+      baseName: "meta",
+      type: "ApplicationKeyResponseMeta",
+    },
   };
 
   /**

packages/datadog-api-client-v2/models/ObjectSerializer.ts

@@ -8,6 +8,8 @@ import { APIKeyUpdateAttributes } from "./APIKeyUpdateAttributes";
 import { APIKeyUpdateData } from "./APIKeyUpdateData";
 import { APIKeyUpdateRequest } from "./APIKeyUpdateRequest";
 import { APIKeysResponse } from "./APIKeysResponse";
+import { APIKeysResponseMeta } from "./APIKeysResponseMeta";
+import { APIKeysResponseMetaPage } from "./APIKeysResponseMetaPage";
 import { ActiveBillingDimensionsAttributes } from "./ActiveBillingDimensionsAttributes";
 import { ActiveBillingDimensionsBody } from "./ActiveBillingDimensionsBody";
 import { ActiveBillingDimensionsResponse } from "./ActiveBillingDimensionsResponse";
@@ -16,6 +18,8 @@ import { ApplicationKeyCreateData } from "./ApplicationKeyCreateData";
 import { ApplicationKeyCreateRequest } from "./ApplicationKeyCreateRequest";
 import { ApplicationKeyRelationships } from "./ApplicationKeyRelationships";
 import { ApplicationKeyResponse } from "./ApplicationKeyResponse";
+import { ApplicationKeyResponseMeta } from "./ApplicationKeyResponseMeta";
+import { ApplicationKeyResponseMetaPage } from "./ApplicationKeyResponseMetaPage";
 import { ApplicationKeyUpdateAttributes } from "./ApplicationKeyUpdateAttributes";
 import { ApplicationKeyUpdateData } from "./ApplicationKeyUpdateData";
 import { ApplicationKeyUpdateRequest } from "./ApplicationKeyUpdateRequest";
@@ -1519,6 +1523,8 @@ const typeMap: { [index: string]: any } = {
   APIKeyUpdateData: APIKeyUpdateData,
   APIKeyUpdateRequest: APIKeyUpdateRequest,
   APIKeysResponse: APIKeysResponse,
+  APIKeysResponseMeta: APIKeysResponseMeta,
+  APIKeysResponseMetaPage: APIKeysResponseMetaPage,
   ActiveBillingDimensionsAttributes: ActiveBillingDimensionsAttributes,
   ActiveBillingDimensionsBody: ActiveBillingDimensionsBody,
   ActiveBillingDimensionsResponse: ActiveBillingDimensionsResponse,
@@ -1527,6 +1533,8 @@ const typeMap: { [index: string]: any } = {
   ApplicationKeyCreateRequest: ApplicationKeyCreateRequest,
   ApplicationKeyRelationships: ApplicationKeyRelationships,
   ApplicationKeyResponse: ApplicationKeyResponse,
+  ApplicationKeyResponseMeta: ApplicationKeyResponseMeta,
+  ApplicationKeyResponseMetaPage: ApplicationKeyResponseMetaPage,
   ApplicationKeyUpdateAttributes: ApplicationKeyUpdateAttributes,
   ApplicationKeyUpdateData: ApplicationKeyUpdateData,
   ApplicationKeyUpdateRequest: ApplicationKeyUpdateRequest,