Fix: Inline enums properties with default values (#152)

fix [#3933](Azure/typespec-azure-pr#3933)
Azure · Feb 6, 2024 · 2f6bbc4 · 2f6bbc4
1 parent d5e2b8a
commit 2f6bbc4
Show file tree

Hide file tree

Showing 5 changed files with 31 additions and 39 deletions.
diff --git a/.changeset/dry-onions-tie.md b/.changeset/dry-onions-tie.md
@@ -0,0 +1,5 @@
+---
+"@azure-tools/typespec-autorest": patch
+---
+
+Fix: Inline enums properties with default values as `default` is not allowed next to `$ref`
diff --git a/packages/samples/test/output/core/optional/@azure-tools/typespec-autorest/openapi.json b/packages/samples/test/output/core/optional/@azure-tools/typespec-autorest/openapi.json
@@ -95,8 +95,16 @@
           }
         },
         "optionalEnum": {
-          "$ref": "#/definitions/MyEnum",
-          "default": "a"
+          "type": "string",
+          "default": "a",
+          "enum": [
+            "a",
+            "b"
+          ],
+          "x-ms-enum": {
+            "name": "MyEnum",
+            "modelAsString": true
+          }
         }
       }
     },

diff --git a/packages/typespec-autorest/src/openapi.ts b/packages/typespec-autorest/src/openapi.ts
@@ -1722,7 +1722,7 @@ function createOAPIEmitter(
         property.description = description;
       }
 
-      if (prop.default) {
+      if (prop.default && !("$ref" in property)) {
         property.default = getDefaultValue(prop.default);
       }
 
@@ -1793,7 +1793,10 @@ function createOAPIEmitter(
   }
 
   function resolveProperty(prop: ModelProperty, visibility: Visibility): OpenAPI2SchemaProperty {
-    const propSchema = getSchemaOrRef(prop.type, visibility);
+    const propSchema =
+      prop.type.kind === "Enum" && prop.default
+        ? getSchemaForEnum(prop.type)
+        : getSchemaOrRef(prop.type, visibility);
     return applyIntrinsicDecorators(prop, propSchema);
   }
 

diff --git a/packages/typespec-autorest/test/models.test.ts b/packages/typespec-autorest/test/models.test.ts
@@ -273,7 +273,7 @@ describe("typespec-autorest: model definitions", () => {
     });
   });
 
-  it("specify default value on enum property", async () => {
+  it("specify default value on enum property inline the enum", async () => {
     const res = await oapiForModel(
       "Foo",
       `
@@ -287,15 +287,20 @@ describe("typespec-autorest: model definitions", () => {
       }
       `
     );
-
-    ok(res.isRef);
-    ok(res.defs.Foo, "expected definition named Foo");
-    ok(res.defs.MyEnum, "expected definition named MyEnum");
     deepStrictEqual(res.defs.Foo, {
       type: "object",
       properties: {
         optionalEnum: {
-          $ref: "#/definitions/MyEnum",
+          type: "string",
+          enum: ["a-value", "b"],
+          "x-ms-enum": {
+            name: "MyEnum",
+            modelAsString: true,
+            values: [
+              { name: "a", value: "a-value" },
+              { name: "b", value: "b" },
+            ],
+          },
           default: "a-value",
         },
       },

diff --git a/packages/typespec-autorest/test/openapi-output.test.ts b/packages/typespec-autorest/test/openapi-output.test.ts
@@ -152,35 +152,6 @@ describe("typespec-autorest: definitions", () => {
     });
   });
 
-  it("specify default value on enum property", async () => {
-    const res = await oapiForModel(
-      "Foo",
-      `
-      model Foo {
-        optionalEnum?: MyEnum = MyEnum.a;
-      };
-      
-      enum MyEnum {
-        a: "a-value",
-        b,
-      }
-      `
-    );
-
-    ok(res.isRef);
-    ok(res.defs.Foo, "expected definition named Foo");
-    ok(res.defs.MyEnum, "expected definition named MyEnum");
-    deepStrictEqual(res.defs.Foo, {
-      type: "object",
-      properties: {
-        optionalEnum: {
-          $ref: "#/definitions/MyEnum",
-          default: "a-value",
-        },
-      },
-    });
-  });
-
   it("ignore uninstantiated template types", async () => {
     const res = await openApiFor(
       `