Skip to content

Commit eecb1ed

Browse files
mattblank11devalog
andauthored
Update overrides.mdx (#523)
Co-authored-by: Devin Logan <[email protected]>
1 parent a804573 commit eecb1ed

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

fern/products/api-def/pages/overrides.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@ title: Overrides
33
description: Customize your API definition using a separate overrides file.
44
---
55

6-
Use an overrides file to customize your API definition without modifying the original spec. This is useful when:
6+
Use an overrides file to customize your OpenAPI, AsyncAPI, OpenRPC, or gRPC definition without modifying the original spec. This is useful when:
77

88
* Your API specification is auto-generated from server code
99
* You need different configurations for SDKs versus documentation
1010

11+
Overrides are available for OpenAPI, AsyncAPI, OpenRPC, and gRPC specifications. They are not needed for [Fern Definition](/api-definitions/ferndef/overview) since you can directly edit those files.
12+
1113
<Note>
12-
While you can also embed Fern extensions directly in your API specification, using overrides files is the recommended approach as it keeps your original spec clean and separates concerns.
14+
While you can also embed [Fern extensions](/api-definitions/overview/overrides#definition-specific-extensions) directly in your API specification, using overrides files is the recommended approach as it keeps your original spec clean and separates concerns.
1315
</Note>
1416

1517
## Implement overrides
@@ -31,7 +33,9 @@ fern/
3133
<Note> The format of the overrides file is independent from the spec. For example, even if your OpenAPI spec is in JSON format, you can write the overrides in yaml. </Note>
3234

3335
</Step>
34-
<Step title="Add customizations">
36+
<Step title="Customize your spec with Fern extensions">
37+
38+
For OpenAPI, AsyncAPI, and OpenRPC, and gRPC, you can use [Fern's extensions](/api-definitions/overview/overrides#definition-specific-extensions) to apply customizations.
3539

3640
```yml title="overrides.yml" {4-5}
3741
paths:
@@ -159,9 +163,9 @@ groups:
159163
version: 0.8.8
160164
```
161165

162-
## Definition-specific customizations
166+
## Definition-specific extensions
163167

164-
Learn more about the customizations you can make for each definition:
168+
Learn more about the Fern extensions you can use to customize your definition:
165169

166170
<CardGroup cols={2}>
167171
<Card title="OpenAPI" href="/api-definitions/openapi/extensions/overview">
@@ -172,4 +176,4 @@ Learn more about the customizations you can make for each definition:
172176
</Card>
173177
<Card title="gRPC" href="/api-definitions/grpc/extensions/overview">
174178
</Card>
175-
</CardGroup>
179+
</CardGroup>

0 commit comments

Comments
 (0)