Fix issue parsing polymorphic schemas (#2131)

Azure · Apr 24, 2024 · e8c2e62 · e8c2e62
1 parent a5f0805
commit e8c2e62
Show file tree

Hide file tree

Showing 13 changed files with 7,866 additions and 67 deletions.
diff --git a/src/autorest.bicep/src/schema-generator.ts b/src/autorest.bicep/src/schema-generator.ts
@@ -324,14 +324,33 @@ export function generateSchema(host: AutorestExtensionHost, definition: Provider
       ancestorsToExclude.add(putSchema);
     }
 
+    const discriminatorName = putSchema?.discriminator?.property.serializedName;
+
     const oneOf: JSONSchema4[] = [];
-    for (const { putSubType } of getDiscriminatedSubTypes(putSchema)) {
+    for (const { subTypeName, putSubType } of getDiscriminatedSubTypes(putSchema)) {
       const childSchema = parseObjectType(putSubType, ancestorsToExclude);
+
+      if (!putSubType.discriminatorValue) {
+        logWarning(`Found discriminated sub-type '${subTypeName}' without discriminator value`);
+        continue;
+      }
+
       if (childSchema.type !== 'object') {
         logWarning(`Found unexpected element of discriminated type '${childSchema.type}'`);
         continue;
       }
 
+      if (discriminatorName) {
+        childSchema.properties ??= {};
+        childSchema.properties[discriminatorName] = {
+          type: 'string',
+          enum: [putSubType.discriminatorValue],
+        };
+
+        childSchema.required = Array.isArray(childSchema.required) ? childSchema.required : [];
+        childSchema.required.push(discriminatorName);
+      }
+
       oneOf.push(childSchema);
     }
 

diff --git a/...utorest.bicep/test/integration/generated/arm-schema/basic/test.rp1/2021-10-31/schema.json b/...utorest.bicep/test/integration/generated/arm-schema/basic/test.rp1/2021-10-31/schema.json
@@ -13,18 +13,20 @@
           ],
           "type": "string"
         },
-        "bar": {
-          "description": "The bar property",
-          "type": "string"
-        },
-        "foo": {
-          "description": "The foo property",
-          "type": "string"
-        },
         "name": {
           "description": "The discriminatedUnionTestType resource name.",
           "type": "string"
         },
+        "properties": {
+          "oneOf": [
+            {
+              "$ref": "#/definitions/DiscriminatedUnionTestTypeProperties"
+            },
+            {
+              "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
+            }
+          ]
+        },
         "type": {
           "enum": [
             "Test.Rp1/discriminatedUnionTestType"
@@ -34,6 +36,7 @@
       },
       "required": [
         "name",
+        "properties",
         "apiVersion",
         "type"
       ],
@@ -294,6 +297,94 @@
     }
   },
   "definitions": {
+    "DiscriminatedUnionTestTypeProperties": {
+      "oneOf": [
+        {
+          "properties": {
+            "baz": {
+              "description": "The baz property",
+              "type": "string"
+            },
+            "quux": {
+              "description": "A property defined inline",
+              "type": "string"
+            },
+            "type": {
+              "enum": [
+                "inherited"
+              ],
+              "type": "string"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "type": "object"
+        },
+        {
+          "properties": {
+            "buzz": {
+              "description": "The buzz property",
+              "type": "string"
+            },
+            "fizz": {
+              "description": "The fizz property",
+              "type": "string"
+            },
+            "pop": {
+              "description": "The pop property",
+              "type": "string"
+            },
+            "type": {
+              "enum": [
+                "inline"
+              ],
+              "type": "string"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "type": "object"
+        },
+        {
+          "properties": {
+            "foo": {
+              "description": "The overridden foo property",
+              "oneOf": [
+                {
+                  "type": "integer"
+                },
+                {
+                  "$ref": "https://schema.management.azure.com/schemas/common/definitions.json#/definitions/expression"
+                }
+              ]
+            },
+            "type": {
+              "enum": [
+                "override"
+              ],
+              "type": "string"
+            }
+          },
+          "required": [
+            "type"
+          ],
+          "type": "object"
+        }
+      ],
+      "properties": {
+        "bar": {
+          "description": "The bar property",
+          "type": "string"
+        },
+        "foo": {
+          "description": "The foo property",
+          "type": "string"
+        }
+      },
+      "type": "object"
+    },
     "EncryptionProperties": {
       "description": "Configuration of key for data encryption",
       "properties": {