Skip to content

Commit 684ef9c

Browse files
authored
docs(api def): small updates to overlays page (#3491)
1 parent 79deec5 commit 684ef9c

2 files changed

Lines changed: 7 additions & 6 deletions

File tree

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

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,14 @@ Overlays let you customize your OpenAPI specification without modifying the orig
88
- Your API specification is auto-generated from server code
99
- You need different configurations for SDKs versus documentation
1010
- You want to add Fern configurations like pagination or SDK method names
11+
- You want to make bulk changes across many endpoints using JSONPath wildcards
1112

12-
Overlays follow the [OpenAPI Overlay Specification](https://spec.openapis.org/overlay/v1.0.0.html).
13+
Overlays follow the [OpenAPI Overlay Specification](https://spec.openapis.org/overlay/v1.0.0.html) and are portable across the OpenAPI ecosystem.
1314

1415
<Note>
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.
16+
Fern recommends using overlays instead of overrides for OpenAPI specs.
1617

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).
18+
[Overrides](/api-definitions/overview/overrides) are also fully supported. If overrides are working for your team, there's no need to switch. You can also use both together (overrides are applied first, then overlays).
1819
</Note>
1920

2021
## Configure overlays

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ Use an overrides file to customize your OpenAPI, AsyncAPI, or OpenRPC definition
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, and OpenRPC specifications. They are not needed for [Fern Definition](/api-definitions/ferndef/overview) since you can directly edit those files.
11+
Overrides are available for OpenAPI, AsyncAPI, and OpenRPC specifications. They're not needed for [Fern Definition](/api-definitions/ferndef/overview) since you can directly edit those files.
1212

1313
<Warning>
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.
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), support bulk changes with JSONPath wildcards, and are portable across the OpenAPI ecosystem.
1515

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).
16+
Overrides are also fully supported. If overrides are working for your team, there's no need to switch. You can also use both together (overrides are applied first, then overlays).
1717
</Warning>
1818

1919
## Implement overrides

0 commit comments

Comments
 (0)