Skip to content

Commit a804573

Browse files
authored
Add info on overrides files to API Definitions/SDKs products (#492)
1 parent 2b16ba8 commit a804573

File tree

17 files changed

+290
-1044
lines changed

17 files changed

+290
-1044
lines changed

fern/docs.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -495,6 +495,18 @@ redirects:
495495
- source: /learn/openapi-definition/extensions/webhooks
496496
destination: /learn/api-definitions/openapi/endpoints/webhooks
497497
permanent: true
498+
- source: /learn/api-definitions/openapi/overlay-customizations
499+
destination: /learn/api-definitions/overview/overrides
500+
permanent: true
501+
- source: /learn/api-definitions/asyncapi/overlay-customizations
502+
destination: /learn/api-definitions/overview/overrides
503+
permanent: true
504+
- source: /learn/api-definitions/openrpc/overlay-customizations
505+
destination: /learn/api-definitions/overview/overrides
506+
permanent: true
507+
- source: /learn/api-definitions/grpc/overlay-customizations
508+
destination: /learn/api-definitions/overview/overrides
509+
permanent: true
498510

499511
# API Definition Fern specific redirects first
500512
- source: /learn/api-definition/fern/endpoints/:slug*

fern/products/api-def/api-def.yml

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ navigation:
55
path: ./pages/what-is-an-api-definition.mdx
66
- page: Project structure
77
path: ./pages/project-structure.mdx
8+
- page: Overrides
9+
path: ./pages/overrides.mdx
810
- section: OpenAPI
911
collapsed: true
1012
slug: openapi
@@ -15,8 +17,6 @@ navigation:
1517
path: ./openapi-pages/auth.mdx
1618
- page: Servers
1719
path: ./openapi-pages/servers.mdx
18-
- page: Automation
19-
path: ./openapi-pages/automation.mdx
2020
slug: sync-your-open-api-specification
2121
- section: Endpoints
2222
slug: endpoints
@@ -63,7 +63,12 @@ navigation:
6363
- page: Schema names
6464
path: ./openapi-pages/extensions/schema-names.mdx
6565
- page: Server names
66-
path: ./openapi-pages/extensions/server-names.mdx
66+
path: ./openapi-pages/extensions/server-names.mdx
67+
- section: Workflow & automation
68+
skip-slug: true
69+
contents:
70+
- page: Sync your OpenAPI specification
71+
path: ./openapi-pages/automation.mdx
6772
- section: Integrate your server framework
6873
slug: frameworks
6974
contents:
@@ -123,8 +128,6 @@ navigation:
123128
- section: Workflow & automation
124129
skip-slug: true
125130
contents:
126-
- page: Overlay customizations
127-
path: ./asyncapi-pages/overrides.mdx
128131
- page: Sync your AsyncAPI specification
129132
path: ./asyncapi-pages/automation.mdx
130133
- section: OpenRPC
@@ -186,8 +189,6 @@ navigation:
186189
- section: Workflow & automation
187190
skip-slug: true
188191
contents:
189-
- page: Overlay customizations
190-
path: ./openrpc-pages/overrides.mdx
191192
- page: Sync your OpenRPC specification
192193
path: ./openrpc-pages/automation.mdx
193194
- section: gRPC
@@ -253,8 +254,6 @@ navigation:
253254
- section: Workflow & automation
254255
skip-slug: true
255256
contents:
256-
- page: Overlay customizations
257-
path: ./grpc-pages/overrides.mdx
258257
- page: Sync your gRPC specification
259258
path: ./grpc-pages/automation.mdx
260259
- section: Fern Definition

fern/products/api-def/asyncapi-pages/extensions/overview.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@ title: Overview of AsyncAPI extensions
33
description: Learn about Fern's AsyncAPI extensions for generating higher-quality SDKs
44
---
55

6-
Fern supports a variety of AsyncAPI extensions that enhance your API specification and generate higher-quality SDKs. You can apply these extensions in two ways: by overlaying them in separate override files or by embedding them directly in your AsyncAPI specification.
6+
Fern supports a variety of AsyncAPI extensions that enhance your API specification and generate higher-quality SDKs.
7+
8+
You can apply these extensions in two ways: by overlaying them in separate override files or by embedding them directly in your AsyncAPI specification. See [Overrides](/api-definitions/overview/overrides) for more information.
79

810
## Available extensions
911

@@ -22,6 +24,4 @@ The table below shows all available extensions and links to detailed documentati
2224

2325
<Note title="Request a new extension">
2426
If there's an extension you want that doesn't already exist, file an [issue](https://github.com/fern-api/fern/issues/new) to start a discussion about it.
25-
</Note>
26-
27-
<Markdown src="/snippets/overlay-embed-extensions.mdx" />
27+
</Note>

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

Lines changed: 0 additions & 168 deletions
This file was deleted.

fern/products/api-def/grpc-pages/extensions/overview.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ description: Learn about Fern's gRPC extensions for generating higher-quality SD
55

66
Fern supports a variety of gRPC extensions that enhance your API specification and generate higher-quality SDKs.
77

8+
You can apply these extensions in two ways: by overlaying them in separate override files or by embedding them directly in your gRPC specification. See [Overrides](/api-definitions/overview/overrides) for more information.
9+
810
## Available extensions
911

1012
The table below shows all available extensions and links to detailed documentation for each one.

0 commit comments

Comments
 (0)