Skip to content

Document coerce-enums-to-literals and idiomatic-request-names (SDKs) #710

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 5, 2025
Merged

Document coerce-enums-to-literals and idiomatic-request-names (SDKs) #710

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion fern/snippets/openapi-specs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ api:
OpenAPI-specific generation settings.
</ParamField>

<ParamField path="title-as-schema-name" type="boolean" default="true" toc={true}>
<ParamField path="settings.title-as-schema-name" type="boolean" default="true" toc={true}>
Whether to use the titles of schemas within an OpenAPI definition as the names of types within Fern.
</ParamField>

Expand Down Expand Up @@ -106,3 +106,14 @@ api:
<ParamField path="example-generation.response.max-depth" type="integer" toc={true}>
Controls the maximum depth for which optional properties will have examples generated in responses.
</ParamField>

<ParamField path="coerce-enums-to-literals" type="boolean" default="true" toc={true}>
Controls whether enums are converted to literal types during code generation. When set to `false`, enums are preserved as enums rather than being converted to literal types. This is useful when you want to maintain the original enum structure from your OpenAPI specification.
</ParamField>

<ParamField path="idiomatic-request-names" type="boolean" default="false" toc={true}>
Controls the naming convention for autogenerated request names. When enabled, places the verb before the noun in request names (e.g., `UsersListRequest` becomes `ListUsersRequest`), following more idiomatic naming patterns.

Disabled by default to maintain backwards compatibility.

</ParamField>