Skip to content

Commit 5707475

Browse files
authored
Standardize references to Pro and Enterprise plans (#921)
1 parent 6cefbc7 commit 5707475

File tree

39 files changed

+78
-31
lines changed

39 files changed

+78
-31
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -141,6 +141,8 @@ components:
141141

142142
## OAuth2 security scheme
143143

144+
<Markdown src="/snippets/pro-plan.mdx"/>
145+
144146
OAuth2 authentication is supported for AsyncAPI specifications:
145147

146148
```yml title="asyncapi.yml" {3-11}

fern/products/api-def/asyncapi-pages/extensions/audiences.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Use audiences to filter your API
33
subtitle: Use `x-fern-audiences` to filter to relevant operations, channels and message schemas
44
---
55

6+
<Markdown src="/snippets/pro-plan.mdx"/>
7+
68
Audiences are a useful tool for segmenting your event-driven API for different consumers. Common examples of audiences include `public`
79
and `beta`.
810

fern/products/api-def/ferndef-pages/audiences.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Audiences in Fern Definition
33
subtitle: Use audiences in your Fern Definition to segment your API for different groups of consumers.
44
---
55

6+
<Markdown src="/snippets/pro-plan.mdx"/>
7+
68
Audiences are a useful tool for segmenting your API for different consumers. You can configure your Fern Docs to publish documentation specific to an `Audience`. You can use [audiences in your OpenAPI Specification](/learn/api-definitions/openapi/extensions/audiences), too.
79

810
Common examples of audiences include:

fern/products/api-def/ferndef-pages/auth.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -178,6 +178,8 @@ client = new Client({
178178

179179
## OAuth client credentials
180180

181+
<Markdown src="/snippets/pro-plan.mdx"/>
182+
181183
If your API uses OAuth, you can specify an oauth scheme in `api.yml` and define a token retrieval endpoint in a separate `auth.yml` file ([example](https://github.com/fern-api/fern/blob/3137938b70e058f3691ddef34d5c1cc29acc4b80/test-definitions/fern/apis/oauth-client-credentials/definition/api.yml)).
182184

183185
```yaml api.yml

fern/products/api-def/ferndef-pages/endpoints/sse.mdx

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@ title: Server-Sent Events and Streaming APIs
33
subtitle: Use the `response-stream` key to model streaming endpoints
44
---
55

6-
<Note>
7-
Specifying `response-stream` on an endpoints allows you to represent endpoint responses that are streaming.
8-
</Note>
6+
<Markdown src="/snippets/pro-plan.mdx"/>
97

8+
Specifying `response-stream` on an endpoints allows you to represent endpoint responses that are streaming.
109

1110
## JSON streaming
1211

fern/products/api-def/ferndef-pages/websockets.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ Fern renders a unique reference page for WebSockets. The **Handshake** section o
8787
8888
### WebSocket Playground
8989
90-
<Markdown src="/snippets/pro-callout.mdx" />
90+
<Markdown src="/snippets/pro-plan.mdx" />
9191
9292
Users can connect to and use WebSockets from right within the API Reference (check one of Hume's WebSockets [here](https://dev.hume.ai/reference/empathic-voice-interface-evi/chat/chat)).
9393

fern/products/api-def/grpc-pages/overview.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: What is gRPC?
33
description: gRPC is a high-performance RPC framework that uses Protocol Buffers
44
---
55

6+
<Markdown src="/snippets/enterprise-plan.mdx"/>
7+
68
<Note>
79
Fern only supports gRPC SDK generation for .NET/C#.
810
</Note>

fern/products/api-def/openapi-pages/endpoints/sse.mdx

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,7 @@ title: Server-Sent Events and Streaming APIs
33
subtitle: Use the `x-fern-streaming` extension to model streaming endpoints
44
---
55

6-
<Note>
7-
The `x-fern-streaming` extension allows you to represent endpoints that are streaming.
8-
</Note>
9-
6+
The `x-fern-streaming` extension allows you to represent endpoints that are streaming.
107

118
## JSON streaming
129

@@ -42,6 +39,8 @@ components:
4239
4340
## Server-sent events
4441
42+
<Markdown src="/snippets/pro-plan.mdx"/>
43+
4544
If your API returns server-sent-events, with the `data` and `event` keys as seen below
4645

4746
```json

fern/products/api-def/openapi-pages/extensions/audiences.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: Use audiences to filter your API
33
subtitle: Use `x-fern-audiences` to filter to relevant endpoints, schemas and properties
44
---
55

6+
<Markdown src="/snippets/pro-plan.mdx"/>
7+
68
Audiences are a useful tool for segmenting your API for different consumers. Common examples of audiences include `public`
79
and `beta`.
810

fern/products/api-def/openrpc-pages/overview.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ title: What is an OpenRPC Specification?
33
description: OpenRPC is a standard for documenting JSON-RPC APIs
44
---
55

6+
<Markdown src="/snippets/enterprise-plan.mdx"/>
7+
68
The OpenRPC Specification is a framework used by developers to document JSON-RPC APIs. The specification
79
is written in JSON or YAML and contains all of your methods, parameters, schemas, and server configurations.
810
Fern is compatible with OpenRPC specification [v1.3.2](https://spec.open-rpc.org/) and [v1.2.6](https://github.com/open-rpc/spec/releases/tag/1.2.6).

0 commit comments

Comments
 (0)