feat: add display name to discriminated union variant (#1448)

fern-api · Sep 11, 2024 · dcb0f74 · dcb0f74
1 parent b5fdb4f
commit dcb0f74
Show file tree

Hide file tree

Showing 14 changed files with 273 additions and 3 deletions.
diff --git a/fern/apis/fdr/definition/api/v1/read/type.yml b/fern/apis/fdr/definition/api/v1/read/type.yml
@@ -174,6 +174,7 @@ types:
       - commons.WithAvailability
     properties:
       discriminantValue: string
+      displayName: optional<string>
       additionalProperties: ObjectType
 
   LiteralType:

diff --git a/fern/apis/fdr/definition/api/v1/register/type.yml b/fern/apis/fdr/definition/api/v1/register/type.yml
@@ -174,6 +174,7 @@ types:
       - commons.WithAvailability
     properties:
       discriminantValue: string
+      displayName: optional<string>
       additionalProperties: ObjectType
 
   LiteralType:

diff --git a/...sources/api/resources/v1/resources/read/resources/type/types/DiscriminatedUnionVariant.ts b/...sources/api/resources/v1/resources/read/resources/type/types/DiscriminatedUnionVariant.ts
diff --git a/...ces/api/resources/v1/resources/register/resources/type/types/DiscriminatedUnionVariant.ts b/...ces/api/resources/v1/resources/register/resources/type/types/DiscriminatedUnionVariant.ts
diff --git a/packages/fdr-sdk/src/converters/db/convertAPIDefinitionToDb.ts b/packages/fdr-sdk/src/converters/db/convertAPIDefinitionToDb.ts
@@ -646,6 +646,7 @@ function transformDiscriminatedVariant({
     return {
         description: writeShape.description,
         availability: writeShape.availability,
+        displayName: writeShape.displayName,
         // htmlDescription,
         // descriptionContainsMarkdown: true,
         discriminantValue: writeShape.discriminantValue,

diff --git a/packages/ui/app/src/api-reference/types/discriminated-union/DiscriminatedUnionVariant.tsx b/packages/ui/app/src/api-reference/types/discriminated-union/DiscriminatedUnionVariant.tsx
@@ -85,7 +85,9 @@ export const DiscriminatedUnionVariant: React.FC<DiscriminatedUnionVariant.Props
                 "px-3": !isRootTypeDefinition,
             })}
         >
-            <span className="fern-api-property-key">{titleCase(unionVariant.discriminantValue)}</span>
+            <span className="fern-api-property-key">
+                {unionVariant.displayName ?? titleCase(unionVariant.discriminantValue)}
+            </span>
             {unionVariant.availability != null && (
                 <EndpointAvailabilityTag availability={unionVariant.availability} minimal={true} />
             )}

diff --git a/packages/ui/app/src/playground/form/PlaygroundDescriminatedUnionForm.tsx b/packages/ui/app/src/playground/form/PlaygroundDescriminatedUnionForm.tsx
@@ -63,7 +63,7 @@ export const PlaygroundDiscriminatedUnionForm = memo<PlaygroundDiscriminatedUnio
             discriminatedUnion.variants.map(
                 (variant): FernDropdown.Option => ({
                     type: "value",
-                    label: titleCase(variant.discriminantValue),
+                    label: variant.displayName ?? titleCase(variant.discriminantValue),
                     value: variant.discriminantValue,
                     // todo: handle availability
                     tooltip: variant.description != null ? <Markdown size="xs" mdx={variant.description} /> : undefined,

diff --git a/packages/ui/app/src/resolver/ApiTypeResolver.ts b/packages/ui/app/src/resolver/ApiTypeResolver.ts
@@ -111,6 +111,7 @@ export class ApiTypeResolver {
                             description: await serializeMdx(variant.description, {
                                 files: this.mdxOptions?.files,
                             }),
+                            displayName: variant.displayName,
                             availability: variant.availability,
                         })),
                     ),

diff --git a/packages/ui/app/src/resolver/types.ts b/packages/ui/app/src/resolver/types.ts
@@ -487,6 +487,7 @@ export interface ResolvedDiscriminatedUnionShapeVariant extends WithMetadata {
     discriminantValue: string;
     extends: string[];
     properties: ResolvedObjectProperty[];
+    displayName?: string;
 }
 
 export interface ResolvedDiscriminatedUnionShape extends WithMetadata {

diff --git a/servers/fdr/package.json b/servers/fdr/package.json
@@ -92,6 +92,7 @@
     "docker:dev": "dotenv -e .env.dev -- ./create_docker.sh",
     "docker:prod": "dotenv -e .env.prod -- ./create_docker.sh",
     "test": "vitest --run src/** --globals",
+    "test:update": "vitest --run src/** --globals -u",
     "lint:eslint": "eslint --max-warnings 0 . --ignore-path=../../.eslintignore",
     "lint:eslint:fix": "pnpm lint:eslint --fix",
     "test:local": "dotenv -e .env.test -- vitest src/__test__/local --globals --config src/__test__/local/vitest.config.ts --no-file-parallelism",