Skip to content

Commit 04807cd

Browse files
committed
clarify wording
1 parent 34086f3 commit 04807cd

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

fern/snippets/openapi-specs.mdx

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -119,16 +119,23 @@ api:
119119
</ParamField>
120120

121121
<ParamField path="resolve-aliases" type="boolean" default="false" toc={true}>
122-
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.
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.
123126

124-
You can preserve specific aliases by adding an `except` array listing the type names to keep as separate types. For example:
127+
Set to `true` to inline all aliases, or use an object with an `except` array
128+
to preserve specific type aliases:
125129

126130
```yaml
127131
settings:
132+
# Inline all aliases
133+
resolve-aliases: true
134+
135+
# Or preserve specific aliases
128136
resolve-aliases:
129137
except:
130138
- UserId
131139
- OrganizationId
132140
```
133-
134141
</ParamField>

0 commit comments

Comments
 (0)