Implement additionalProperties on all models by default (#1532)

* implement additionalProperties

* handle empty object being falsy

Author: nkzou

.generator/src/generator/openapi.py

@@ -55,6 +55,8 @@ def form_parameter(operation):
 
 def type_to_typescript(schema, alternative_name=None, check_nullable=True):
     """Return Typescript type name for the type."""
+    if schema is True or schema is {}:
+        return "any"
     name = get_name(schema)
     if name and "items" not in schema and not is_primitive(schema):
         if "enum" in schema:

.generator/src/generator/templates/model/ObjectSerializer.j2

@@ -127,22 +127,43 @@ export class ObjectSerializer {
       const attributesMap = typeMap[type].getAttributeTypeMap();
       const instance: {[index: string]: any} = {};
 
-      for (const attributeName in attributesMap) {
+      for (const attributeName in data) {
         const attributeObj = attributesMap[attributeName];
-        if (attributeName == "additionalProperties") {
-          if (data.additionalProperties) {
-            for (const key in data.additionalProperties) {
-              instance[key] = ObjectSerializer.serialize(
-                data.additionalProperties[key],
-                attributeObj.type,
-                attributeObj.format
-              );
-            }
-          }
+        if (
+          attributeName === "_unparsed" ||
+          attributeName === "additionalProperties"
+        ) {
           continue;
+        } else if (
+          attributeObj === undefined &&
+          !("additionalProperties" in attributesMap)
+        ) {
+          throw new Error(
+            "unexpected attribute " + attributeName + " of type " + type
+          );
+        } else if (attributeObj) {
+          instance[attributeObj.baseName] = ObjectSerializer.serialize(
+            data[attributeName],
+            attributeObj.type,
+            attributeObj.format
+          );
         }
-        instance[attributeObj.baseName] = ObjectSerializer.serialize(data[attributeName], attributeObj.type, attributeObj.format);
-        // check for required properties
+      }
+
+      let additionalProperties = attributesMap["additionalProperties"]
+      if (additionalProperties && data.additionalProperties) {
+        for (const key in data.additionalProperties) {
+          instance[key] = ObjectSerializer.serialize(
+            data.additionalProperties[key],
+            additionalProperties.type,
+            additionalProperties.format
+          );
+        }
+      }
+
+      // check for required properties
+      for (const attributeName in attributesMap) {
+        const attributeObj = attributesMap[attributeName];
         if (attributeObj?.required && instance[attributeObj.baseName] === undefined) {
           throw new Error(`missing required property '${attributeObj.baseName}'`);
         }

.generator/src/generator/templates/model/model.j2

@@ -33,14 +33,14 @@ export class {{ name }} {
 {%- endif %}
   "{{ attr|attribute_name }}"{%- if not isRequired %}?{%- endif %}: {{ type_to_typescript(schema) }}{%- if isRequired and isNullable %}|null{%- endif %};
 {%- endfor %}
-{%- if model.get("additionalProperties") %}
+{%- if model.additionalProperties is not false %}
 
   /**
    * A container for additional, undeclared properties.
    * This is a holder for any undeclared properties as specified with
    * the 'additionalProperties' keyword in the OAS document.
    */
-  "additionalProperties"?: { [key: string]: {{ type_to_typescript(model["additionalProperties"]) }} };
+  "additionalProperties"?: { [key: string]: {{ type_to_typescript(model.get("additionalProperties", {})) }} };
 {%- endif %}
 
   /**
@@ -65,13 +65,13 @@ export class {{ name }} {
       {%- if format %}
       "format": "{{ format }}",
       {%- endif %}
-    }{%- if loop.nextitem or model.get("additionalProperties") %},{%- endif %}
+    }{%- if loop.nextitem or model.additionalProperties is not false %},{%- endif %}
     {%- endfor %}
-    {%- if model.get("additionalProperties") %}
-    {%- set format = get_format_for_schema(model["additionalProperties"]) %}
+    {%- if model.additionalProperties is not false %}
+    {%- set format = get_format_for_schema(model.get("additionalProperties", {})) %}
     "additionalProperties": {
       "baseName": "additionalProperties",
-      "type": "{{ type_to_typescript(model["additionalProperties"], check_nullable=False) }}",
+      "type": "{{ type_to_typescript(model.get("additionalProperties", {}), check_nullable=False) }}",
       {%- if format %}
       "format": "{{ format }}",
       {%- endif %}

packages/datadog-api-client-v1/models/APIErrorResponse.ts

@@ -15,6 +15,13 @@ export class APIErrorResponse {
    */
   "errors": Array<string>;
 
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+
   /**
    * @ignore
    */
@@ -29,6 +36,10 @@ export class APIErrorResponse {
       type: "Array<string>",
       required: true,
     },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "any",
+    },
   };
 
   /**

packages/datadog-api-client-v1/models/AWSAccount.ts

@@ -64,6 +64,13 @@ export class AWSAccount {
    */
   "secretAccessKey"?: string;
 
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+
   /**
    * @ignore
    */
@@ -117,6 +124,10 @@ export class AWSAccount {
       baseName: "secret_access_key",
       type: "string",
     },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "any",
+    },
   };
 
   /**

packages/datadog-api-client-v1/models/AWSAccountAndLambdaRequest.ts

@@ -19,6 +19,13 @@ export class AWSAccountAndLambdaRequest {
    */
   "lambdaArn": string;
 
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+
   /**
    * @ignore
    */
@@ -38,6 +45,10 @@ export class AWSAccountAndLambdaRequest {
       type: "string",
       required: true,
     },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "any",
+    },
   };
 
   /**

packages/datadog-api-client-v1/models/AWSAccountCreateResponse.ts

@@ -15,6 +15,13 @@ export class AWSAccountCreateResponse {
    */
   "externalId"?: string;
 
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+
   /**
    * @ignore
    */
@@ -28,6 +35,10 @@ export class AWSAccountCreateResponse {
       baseName: "external_id",
       type: "string",
     },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "any",
+    },
   };
 
   /**

packages/datadog-api-client-v1/models/AWSAccountDeleteRequest.ts

@@ -23,6 +23,13 @@ export class AWSAccountDeleteRequest {
    */
   "roleName"?: string;
 
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+
   /**
    * @ignore
    */
@@ -44,6 +51,10 @@ export class AWSAccountDeleteRequest {
       baseName: "role_name",
       type: "string",
     },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "any",
+    },
   };
 
   /**

packages/datadog-api-client-v1/models/AWSAccountListResponse.ts

@@ -16,6 +16,13 @@ export class AWSAccountListResponse {
    */
   "accounts"?: Array<AWSAccount>;
 
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+
   /**
    * @ignore
    */
@@ -29,6 +36,10 @@ export class AWSAccountListResponse {
       baseName: "accounts",
       type: "Array<AWSAccount>",
     },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "any",
+    },
   };
 
   /**

packages/datadog-api-client-v1/models/AWSEventBridgeAccountConfiguration.ts

@@ -25,6 +25,13 @@ export class AWSEventBridgeAccountConfiguration {
    */
   "tags"?: Array<string>;
 
+  /**
+   * A container for additional, undeclared properties.
+   * This is a holder for any undeclared properties as specified with
+   * the 'additionalProperties' keyword in the OAS document.
+   */
+  "additionalProperties"?: { [key: string]: any };
+
   /**
    * @ignore
    */
@@ -46,6 +53,10 @@ export class AWSEventBridgeAccountConfiguration {
       baseName: "tags",
       type: "Array<string>",
     },
+    additionalProperties: {
+      baseName: "additionalProperties",
+      type: "any",
+    },
   };
 
   /**