Skip to content

Commit baa607c

Browse files
authored
(api definitions, cli) Document resolve-aliases option (#1079)
1 parent f8c42ad commit baa607c

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

fern/snippets/openapi-specs.mdx

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,3 +117,25 @@ api:
117117
Disabled by default to maintain backwards compatibility.
118118

119119
</ParamField>
120+
121+
<ParamField path="resolve-aliases" type="boolean" default="false" toc={true}>
122+
Inlines type aliases to simplify your generated SDK. When enabled, reduces
123+
unnecessary type definitions by replacing simple aliases with their underlying
124+
types directly. Useful for OpenAPI specs with many primitive or simple type
125+
aliases.
126+
127+
Set to `true` to inline all aliases, or use an object with an `except` array
128+
to preserve specific type aliases:
129+
130+
```yaml
131+
settings:
132+
# Inline all aliases
133+
resolve-aliases: true
134+
135+
# Or preserve specific aliases
136+
resolve-aliases:
137+
except:
138+
- UserId
139+
- OrganizationId
140+
```
141+
</ParamField>

0 commit comments

Comments
 (0)