fix(cli): validating union examples takes into account base-properties (

#5032)
fern-api · Oct 29, 2024 · f25e5ea · f25e5ea
1 parent 85cc59e
commit f25e5ea
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 1 deletion.
diff --git a/generators/csharp/sdk/versions.yml b/generators/csharp/sdk/versions.yml
@@ -10,6 +10,7 @@
     - type: fix
       summary: |
         Fixes a bug where the ClientOptions would not compile due to incorrect Clone method generation.
+  irVersion: 53
 - version: 1.8.1
   irVersion: 53
   createdAt: "2024-10-08"

diff --git a/packages/cli/cli/versions.yml b/packages/cli/cli/versions.yml
@@ -1,3 +1,10 @@
+- changelogEntry:
+    - summary: |
+        `fern check` handles validating unions that contain base properties. 
+      type: feat
+  irVersion: 53
+  version: 0.45.0-rc26
+
 - changelogEntry:
     - summary: |
         The Fern CLI temporarily does not support RBAC/Audiences (they will be added in again shortly). 

diff --git a/packages/cli/generation/ir-generator/src/examples/validateUnionExample.ts b/packages/cli/generation/ir-generator/src/examples/validateUnionExample.ts
@@ -61,6 +61,30 @@ export function validateUnionExample({
         ];
     }
 
+    if (rawUnion["base-properties"] != null) {
+        const example = Object.fromEntries(
+            Object.entries(nonDiscriminantPropertyExamples).filter(
+                ([key]) => rawUnion["base-properties"]?.[key] != null
+            )
+        );
+        const basePropertyViolations = validateObjectExample({
+            typeName,
+            typeNameForBreadcrumb: typeName,
+            rawObject: {
+                properties: rawUnion["base-properties"]
+            },
+            file,
+            example,
+            typeResolver,
+            exampleResolver,
+            workspace,
+            breadcrumbs
+        });
+        if (basePropertyViolations.length > 0) {
+            return basePropertyViolations;
+        }
+    }
+
     const type =
         typeof singleUnionTypeDefinition === "string" ? singleUnionTypeDefinition : singleUnionTypeDefinition.type;
 
@@ -79,12 +103,17 @@ export function validateUnionExample({
     }
 
     if (resolvedType._type === "named" && isRawObjectDefinition(resolvedType.declaration)) {
+        const example = Object.fromEntries(
+            Object.entries(nonDiscriminantPropertyExamples).filter(
+                ([key]) => rawUnion["base-properties"]?.[key] == null
+            )
+        );
         return validateObjectExample({
             typeName,
             typeNameForBreadcrumb: typeName,
             rawObject: resolvedType.declaration,
             file: resolvedType.file,
-            example: nonDiscriminantPropertyExamples,
+            example,
             typeResolver,
             exampleResolver,
             workspace,