Skip to content

Commit 0de6c7a

Browse files
devin-ai-integration[bot]fern-supportdevalog
authored
docs: clarify that overrides are fully supported alongside overlays (#3333)
Co-authored-by: fern-support <support@buildwithfern.com> Co-authored-by: Fern Support <info@buildwithfern.com> Co-authored-by: Devin Logan <devinannlogan@gmail.com>
1 parent 882741b commit 0de6c7a

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
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 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.
1616

17-
Fern still supports overrides for backward compatibility.
17+
[Overrides](/api-definitions/overview/overrides) are also fully supported. If your team already uses overrides, there's no need to switch unless you need advanced functionality. You can also use both together (overrides are applied first, then overlays).
1818
</Note>
1919

2020
## Configure overlays

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ Use an overrides file to customize your OpenAPI, AsyncAPI, or OpenRPC definition
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

1313
<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.
14+
For OpenAPI specs, Fern recommends using [overlays](/learn/api-definitions/openapi/overlays) instead of overrides. Overlays follow the official [OpenAPI Overlay Specification](https://spec.openapis.org/overlay/v1.0.0.html) and are portable across different tools.
15+
16+
However, overrides are also fully supported. If your team already uses overrides, there's no need to switch unless you need advanced functionality. You can also use both together (overrides are applied first, then overlays).
1517
</Warning>
1618

1719
## Implement overrides
@@ -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)