Fix enum in union example (#4462)

fix #4416
microsoft · Oct 4, 2024 · 7c425cd · 7c425cd
1 parent 0d1b320
commit 7c425cd
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 3 deletions.
diff --git a/.chronus/changes/fix-enum-in-union-example-2024-8-17-18-25-2.md b/.chronus/changes/fix-enum-in-union-example-2024-8-17-18-25-2.md
@@ -0,0 +1,8 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: fix
+packages:
+  - "@typespec/compiler"
+---
+
+Fix examples with enums inside of unions
diff --git a/packages/compiler/src/lib/examples.ts b/packages/compiler/src/lib/examples.ts
@@ -74,11 +74,10 @@ function resolveUnions(program: Program, value: ObjectValue, type: Type): Type |
   }
   for (const variant of type.variants.values()) {
     if (
-      variant.type.kind === "Model" &&
       ignoreDiagnostics(
         program.checker.isTypeAssignableTo(
-          value,
-          { entityKind: "MixedParameterConstraint", valueType: variant.type },
+          value.type.projectionBase ?? value.type,
+          variant.type.projectionBase ?? variant.type,
           value,
         ),
       )

diff --git a/packages/openapi3/test/examples.test.ts b/packages/openapi3/test/examples.test.ts
@@ -31,6 +31,25 @@ describe("schema examples", () => {
     );
     expect(res.components.schemas.Test.example).toEqual({ dob: "2021-01-01" });
   });
+
+  it("enum in union", async () => {
+    const res = await openApiFor(
+      `
+      enum Types {a, b}
+
+      model A { type: Types;}
+
+      union Un { A }
+
+      @example(#{ prop: #{ type: Types.a } })
+      model Test {
+        prop: Un;
+      }
+
+      `,
+    );
+    expect(res.components.schemas.Test.example).toEqual({ prop: { type: "a" } });
+  });
 });
 
 describe("operation examples", () => {