Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions fern/products/api-def/asyncapi/auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -142,8 +142,6 @@ components:

## OAuth2 security scheme

<Markdown src="/snippets/team-or-enterprise-plan.mdx"/>

OAuth2 authentication is supported for AsyncAPI specifications:

```yml title="asyncapi.yml" {3-11}
Expand Down
2 changes: 1 addition & 1 deletion fern/products/api-def/asyncapi/extensions/audiences.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ subtitle: Use `x-fern-audiences` to filter to relevant operations, channels and
---


<Markdown src="/snippets/team-or-enterprise-plan.mdx"/>
<Markdown src="/snippets/enterprise-plan-sdks.mdx"/>

Audiences are a useful tool for segmenting your event-driven API for different consumers. Common examples of audiences include `public`
and `beta`.
Expand Down
2 changes: 1 addition & 1 deletion fern/products/api-def/ferndef/audiences.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ noindex: true
<Markdown src="/products/api-def/snippets/ferndef-support.mdx" />


<Markdown src="/snippets/team-or-enterprise-plan.mdx"/>
<Markdown src="/snippets/enterprise-plan-sdks.mdx"/>

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.

Expand Down
2 changes: 0 additions & 2 deletions fern/products/api-def/ferndef/auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -182,8 +182,6 @@ client = new Client({

## OAuth client credentials

<Markdown src="/snippets/team-or-enterprise-plan.mdx"/>

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)).

```yaml api.yml
Expand Down
2 changes: 1 addition & 1 deletion fern/products/api-def/ferndef/endpoints/sse.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ noindex: true
<Markdown src="/products/api-def/snippets/ferndef-support.mdx" />


<Markdown src="/snippets/team-or-enterprise-plan.mdx"/>
<Markdown src="/snippets/enterprise-plan-sdks.mdx"/>

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

Expand Down
2 changes: 1 addition & 1 deletion fern/products/api-def/openapi/endpoints/sse.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ components:

## Server-sent events

<Markdown src="/snippets/team-or-enterprise-plan.mdx"/>
<Markdown src="/snippets/enterprise-plan-sdks.mdx"/>

If your API returns server-sent-events (SSE), with the `data` and `event` keys as seen below

Expand Down
2 changes: 1 addition & 1 deletion fern/products/api-def/openapi/extensions/audiences.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ subtitle: Learn how to use x-fern-audiences to filter OpenAPI endpoints, schemas
---


<Markdown src="/snippets/team-or-enterprise-plan.mdx"/>
<Markdown src="/snippets/enterprise-plan-sdks.mdx"/>

Fern provides two ways to filter which API elements appear in your SDKs and API Reference docs:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ description: Configure idempotency for safe request retries using x-fern-idempot
---


<Markdown src="/snippets/enterprise-plan.mdx"/>

Fern supports idempotency configuration through two extensions that work together: `x-fern-idempotency-headers` configures the idempotency headers your API uses, and `x-fern-idempotent` marks individual endpoints as idempotent. When configured, Fern's generated SDKs allow users to specify idempotency headers for safe request retries.

## Configure idempotency headers
Expand Down
2 changes: 0 additions & 2 deletions fern/products/api-def/openapi/extensions/pagination.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ description: Configure auto-pagination for list endpoints using the x-fern-pagin
---


<Markdown src="/snippets/enterprise-plan.mdx"/>

The `x-fern-pagination` extension configures auto-pagination for list endpoints in your OpenAPI specification. [SDK](/learn/sdks/deep-dives/auto-pagination) and [CLI](/learn/cli-generator/get-started/openapi-extensions#pagination) users get automatic pagination without managing page tokens manually.

To configure pagination:
Expand Down
2 changes: 0 additions & 2 deletions fern/products/dashboard/pages/pdf-export.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: Export your documentation site as a PDF from the Fern Dashboard.
---


<Markdown src="/snippets/team-plan.mdx"/>

Export your documentation as a PDF directly from the [Fern Dashboard](https://dashboard.buildwithfern.com/). The generated PDF includes a cover page, table of contents with clickable links, and all content pages with headers and footers.

## Export your documentation
Expand Down
3 changes: 1 addition & 2 deletions fern/products/dashboard/pages/permissions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,5 @@ Your [plan](https://buildwithfern.com/pricing) determines how many members you c

| Plan | Team members |
| ---------- | ------------ |
| Hobby | 2 |
| Team | 5 |
| Free | 10 |
| Enterprise | Custom |
2 changes: 1 addition & 1 deletion fern/products/docs/pages/ai/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Your documentation site comes with automatic optimizations for AI tools, plus fe

<Anchor id="ai-credits">
<Tip title="AI credits">
AI features are usage-based and consume credits. Every [plan](https://buildwithfern.com/pricing) includes a monthly credit allowance: Hobby plans get 250 credits, Team plans get 1,000 credits, and Enterprise plans get a custom amount.
AI features are usage-based and consume credits. Every [plan](https://buildwithfern.com/pricing) includes a monthly credit allowance: the Free plan gets 250 credits, and the Enterprise plan gets a custom amount.

| Feature | Credits |
| --- | --- |
Expand Down
2 changes: 0 additions & 2 deletions fern/products/docs/pages/api-references/audiences.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ subtitle: Use audiences to filter the endpoints, schemas, and properties that ar
---


<Markdown src="/snippets/team-plan.mdx"/>

Audiences are a useful tool for segmenting your API for different consumers. Common examples of audiences include `public`
and `beta`.

Expand Down
2 changes: 0 additions & 2 deletions fern/products/docs/pages/ask-fern/api-get-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ subtitle: 'Welcome to the Fern API Reference.'
---


<Markdown src="/snippets/team-plan.mdx" />

The Fern AI API allows you to manage your Ask Fern configuration using Fern's public RESTful API. You can use the API to:

- Build your own support integrations that leverage Ask Fern's AI-powered search
Expand Down
4 changes: 1 addition & 3 deletions fern/products/docs/pages/authentication/rbac.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ subtitle: Show different docs to different customers
description: Restrict pages by role, team, or pricing tier so each audience sees only what they should.
---

<Warning title="Team and Enterprise feature">
Password-based RBAC is available on the [Team and Enterprise plans](https://buildwithfern.com/pricing). SSO, JWT, and OAuth-based RBAC require the [Enterprise plan](https://buildwithfern.com/pricing).
</Warning>
<Markdown src="/snippets/enterprise-plan.mdx"/>

RBAC gates pages, sections, and other navigation items by role so each audience sees only the content meant for them. It works with [password protection](/learn/docs/authentication/setup/password-protection), [SSO](/learn/docs/authentication/setup/sso), [JWT](/learn/docs/authentication/setup/jwt), and [OAuth](/learn/docs/authentication/setup/oauth) authentication.

Expand Down
1 change: 1 addition & 0 deletions fern/products/docs/pages/customization/custom-css-js.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ subtitle: Add custom CSS, global JavaScript, and UI components.
description: Learn how to add custom CSS, JavaScript, and UI components to your Fern documentation. Style your docs with custom classes and scripts.
---

<Markdown src="/snippets/enterprise-plan.mdx"/>

This page covers CSS and JavaScript customization:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ description: Add custom React components to your Fern docs for interactive, serv
slug: customization/custom-react-components
---

<Markdown src="/snippets/enterprise-plan.mdx"/>

You can extend Fern's built-in component library by adding your own custom React components. This allows you to create unique, interactive elements that match your documentation needs. Components are server-side rendered for better SEO and performance, with no layout shifts.

<Frame caption="Merge uses a custom React component to compare feature coverage across integrations in an [interactive matrix](https://docs.merge.dev/merge-unified/hris/integrations/supported-features).">
Expand Down
2 changes: 0 additions & 2 deletions fern/products/docs/pages/integrations/feature-flags.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ description: Learn how to use Feature Flags in your Fern documentation
---


<Markdown src="/snippets/team-plan.mdx"/>

Fern supports conditional rendering of documentation content using feature flags, powered by [LaunchDarkly](https://app.launchdarkly.com/signup) integration. Control visibility of documentation sections based on feature flag states for different release stages or user segments.

## Use cases
Expand Down
2 changes: 2 additions & 0 deletions fern/products/docs/pages/localization/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ title: Localization
subtitle: Ship documentation in multiple languages from a single source
---

<Markdown src="/snippets/enterprise-plan.mdx"/>

Fern lets you publish your documentation in multiple languages from a single set of source files. Readers switch languages from a dropdown in the header, [search](/learn/docs/customization/search) is scoped to the active language, and each locale has its own URL so search engines can index it separately.

You supply the translations and Fern handles the rest: rendering a language switcher in the header, scoping each locale to its own URL path, and falling back to the default language for any page you haven't translated yet.
Expand Down
2 changes: 0 additions & 2 deletions fern/products/docs/pages/navigation/products.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ description: Configure multi-product documentation in Fern, including the produc
---


<Markdown src="/snippets/team-plan.mdx"/>

Products add a switcher to your docs for documenting distinct offerings. Each product can contain its own navigation, tabs, versions, and API references, and products can share content.

Products can be internal (hosted on your site) or external (linking to external URLs).
Expand Down
2 changes: 0 additions & 2 deletions fern/products/docs/pages/navigation/versions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ description: Configure versioned documentation in Fern, including the version dr
---


<Markdown src="/snippets/team-plan.mdx"/>

Versions add a dropdown to your docs for multiple releases of the same content. Each version can contain its own tabs, sections, pages, and API references, and versions can share content.

<Frame>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,6 @@ Once Fern has completed your setup, you'll be able to access your documentation

<Accordion title="Subpath">

<Markdown src="/snippets/team-plan.mdx"/>

To host your documentation on a subpath like `mydomain.com/docs`, you need to edit your `docs.yml` configuration and set up a reverse proxy on your infrastructure.

<Steps>
Expand Down
2 changes: 0 additions & 2 deletions fern/products/sdks/deep-dives/configure-auto-pagination.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: Paginate through API responses with offset, cursor, URI, and path-b
---


<Markdown src="/snippets/enterprise-plan.mdx"/>

Fern's auto-pagination supports offset, cursor, URI, and path-based
pagination schemes, providing SDK users with simple iterators to loop through all
results instead of managing pagination complexity manually.
Expand Down
2 changes: 0 additions & 2 deletions fern/products/sdks/deep-dives/configure-idempotency.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: Configure idempotency headers for SDKs that support retrying reques
---


<Markdown src="/snippets/enterprise-plan.mdx"/>

For endpoints you've configured as idempotent, Fern's SDKs allow users to
specify idempotency headers for safe request retries. Typically the headers include `Idempotency-Key`,
but you can also specify additional headers.
Expand Down
2 changes: 0 additions & 2 deletions fern/products/sdks/deep-dives/retries-with-backoff.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,6 @@ description: Learn how to configure automatic retries with exponential backoff i
---


<Markdown src="/snippets/enterprise-plan.mdx" />

Fern SDKs will automatically retry failed requests with exponential backoff. A request will be retried as
long as the request is deemed retryable and the number of retry attempts has
not grown larger than the configured retry limit.
Expand Down
3 changes: 3 additions & 0 deletions fern/snippets/enterprise-plan-sdks.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
<Warning title="Enterprise feature for SDKs">
Using this feature in generated SDKs requires the [Enterprise plan](https://buildwithfern.com/pricing). API Reference docs can use it on all plans. To get started, reach out to support@buildwithfern.com.
</Warning>
Loading