You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: fern/products/api-def/pages/overrides.mdx
+10-6Lines changed: 10 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,13 +3,15 @@ title: Overrides
3
3
description: Customize your API definition using a separate overrides file.
4
4
---
5
5
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:
7
7
8
8
* Your API specification is auto-generated from server code
9
9
* You need different configurations for SDKs versus documentation
10
10
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
+
11
13
<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.
13
15
</Note>
14
16
15
17
## Implement overrides
@@ -31,7 +33,9 @@ fern/
31
33
<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>
32
34
33
35
</Step>
34
-
<Steptitle="Add customizations">
36
+
<Steptitle="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.
35
39
36
40
```yml title="overrides.yml" {4-5}
37
41
paths:
@@ -159,9 +163,9 @@ groups:
159
163
version: 0.8.8
160
164
```
161
165
162
-
## Definition-specific customizations
166
+
## Definition-specific extensions
163
167
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:
0 commit comments