Skip to content

Commit 9dcebc1

Browse files
committed
docs: clarify that overrides are fully supported alongside overlays
Co-Authored-By: Fern Support <info@buildwithfern.com>
1 parent 0c48135 commit 9dcebc1

File tree

2 files changed

+8
-6
lines changed

2 files changed

+8
-6
lines changed

fern/products/api-def/openapi-pages/overlays.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@ Overlays let you customize your OpenAPI specification without modifying the orig
1212
Overlays follow the [OpenAPI Overlay Specification](https://spec.openapis.org/overlay/v1.0.0.html).
1313

1414
<Note>
15-
Overlays are the recommended approach for customizing OpenAPI specifications. Compared to [overrides](/api-definitions/overview/overrides), overlays offer additional capabilities like bulk modifications using JSONPath wildcards and the ability to modify elements within arrays.
15+
Fern fully supports both overlays and [overrides](/api-definitions/overview/overrides). If overrides are working for your team, there's no need to switch. Overlays are useful if you need advanced functionality like bulk modifications using JSONPath wildcards or the ability to modify elements within arrays.
1616

17-
Fern still supports overrides for backward compatibility.
17+
You can use both together: overrides are applied first, then overlays.
1818
</Note>
1919

2020
## Configure overlays

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,11 @@ Use an overrides file to customize your OpenAPI, AsyncAPI, or OpenRPC definition
1010

1111
Overrides are available for OpenAPI, AsyncAPI, and OpenRPC specifications. They are not needed for [Fern Definition](/api-definitions/ferndef/overview) since you can directly edit those files.
1212

13-
<Warning>
14-
Fern recommends using [OpenAPI overlays](/api-definitions/openapi/overlays) instead of overrides for OpenAPI specs. Overlays follow the official [OpenAPI Overlay Specification](https://spec.openapis.org/overlay/v1.0.0.html) and are portable across different tools. Fern still supports OpenAPI overrides for backward compatibility.
15-
</Warning>
13+
<Note>
14+
Fern fully supports both overrides and [OpenAPI overlays](/api-definitions/openapi/overlays). If overrides are working for your team, there's no need to switch. Overlays are useful if you need advanced functionality like bulk modifications using JSONPath wildcards or the ability to modify elements within arrays.
15+
16+
You can use both together: overrides are applied first, then overlays.
17+
</Note>
1618

1719
## Implement overrides
1820

@@ -102,4 +104,4 @@ paths:
102104

103105
## Overrides for different environments
104106

105-
<Markdown src="/snippets/different-environments.mdx" type="overrides" />
107+
<Markdown src="/snippets/different-environments.mdx" type="overrides" />

0 commit comments

Comments
 (0)