Skip to content

(api definitions, cli) Document resolve-aliases option #1079

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 2 commits into from
Oct 2, 2025
Merged

(api definitions, cli) Document resolve-aliases option #1079

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
34086f3
document resolve-aliases
devalog Oct 2, 2025
04807cd
clarify wording
devalog Oct 2, 2025
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
22 changes: 22 additions & 0 deletions fern/snippets/openapi-specs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,25 @@ api:
Disabled by default to maintain backwards compatibility.

</ParamField>

<ParamField path="resolve-aliases" type="boolean" default="false" toc={true}>
Inlines type aliases to simplify your generated SDK. When enabled, reduces
unnecessary type definitions by replacing simple aliases with their underlying
types directly. Useful for OpenAPI specs with many primitive or simple type
aliases.

Set to `true` to inline all aliases, or use an object with an `except` array
to preserve specific type aliases:

```yaml
settings:
# Inline all aliases
resolve-aliases: true

# Or preserve specific aliases
resolve-aliases:
except:
- UserId
- OrganizationId
```
</ParamField>