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
48 changes: 42 additions & 6 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -351,7 +351,7 @@ redirects:
- source: /learn/docs/building-and-customizing-your-docs/custom-domain
destination: /learn/docs/preview-publish/setting-up-your-domain
- source: /learn/docs/building-and-customizing-your-docs/rbac
destination: /learn/docs/authentication/rbac
destination: /learn/docs/authentication/features/rbac
- source: /learn/docs/building-and-customizing-your-docs/search
destination: /learn/docs/customization/search

Expand Down Expand Up @@ -395,13 +395,49 @@ redirects:
destination: /learn/docs/api-references/customize-api-reference-layout#configuration-options

- source: /learn/docs/api-references/server-urls
destination: /learn/docs/api-references/api-explorer/overview#multiple-environments
- source: /learn/docs/api-references/api-explorer
destination: /learn/docs/api-references/api-explorer/overview
destination: /learn/docs/api-references/api-explorer#multiple-environments
- source: /learn/docs/api-references/api-playground/:slug*
destination: /learn/docs/api-references/api-explorer/:slug*
- source: /learn/docs/api-references/api-playground
destination: /learn/docs/api-references/api-explorer/overview
destination: /learn/docs/api-references/api-explorer

# Authentication redirects — old locations → new Setup/Features structure
- source: /learn/docs/authentication/password-protection
destination: /learn/docs/authentication/setup/password-protection
- source: /learn/docs/authentication/sso
destination: /learn/docs/authentication/setup/sso
- source: /learn/docs/authentication/jwt
destination: /learn/docs/authentication/setup/jwt
- source: /learn/docs/authentication/oauth
destination: /learn/docs/authentication/setup/oauth
- source: /learn/docs/authentication/rbac
destination: /learn/docs/authentication/features/rbac
- source: /learn/docs/authentication/api-key-injection
destination: /learn/docs/authentication/features/api-key-injection

# Authentication redirects — legacy paths
- source: /learn/docs/authentication/rbac/overview
destination: /learn/docs/authentication/features/rbac
- source: /learn/docs/authentication/api-key-injection/overview
destination: /learn/docs/authentication/features/api-key-injection
- source: /learn/docs/authentication/set-up-oauth
destination: /learn/docs/authentication/setup/oauth
- source: /learn/docs/authentication/jwt-setup
destination: /learn/docs/authentication/setup/jwt
- source: /learn/docs/authentication/oauth-setup
destination: /learn/docs/authentication/setup/oauth
- source: /learn/docs/authentication/auth-setup/jwt-setup
destination: /learn/docs/authentication/setup/jwt
- source: /learn/docs/authentication/auth-setup/oauth-setup
destination: /learn/docs/authentication/setup/oauth
- source: /learn/docs/authentication/rbac/jwt-setup
destination: /learn/docs/authentication/setup/jwt
- source: /learn/docs/authentication/rbac/oauth-setup
destination: /learn/docs/authentication/setup/oauth
- source: /learn/docs/authentication/api-key-injection/jwt-setup
destination: /learn/docs/authentication/setup/jwt
- source: /learn/docs/authentication/api-key-injection/oauth-setup
destination: /learn/docs/authentication/setup/oauth
- source: /learn/user-feedback
destination: /learn/docs/user-feedback
- source: /learn/docs/customization/what-is-docs-yml
Expand Down Expand Up @@ -648,7 +684,7 @@ redirects:
- source: /learn/docs/alternatives/mintlify
destination: /learn/docs/getting-started/overview
- source: /learn/docs/api-references/api-explorer/advanced-configuration
destination: /learn/docs/api-references/api-explorer/overview
destination: /learn/docs/api-references/api-explorer
- source: /learn/docs/enterprise/self-hosted
destination: /learn/docs/self-hosted/overview
- source: /learn/docs/content/visual-editor-beta
Expand Down
4 changes: 2 additions & 2 deletions fern/products/api-def/openapi-pages/extensions/explorer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ headline: API Explorer control (OpenAPI)
description: Enable or disable the API Explorer using `x-fern-explorer`
---

The [API Explorer](/learn/docs/api-references/api-explorer/overview) is enabled by default for all endpoints. Use `x-fern-explorer` to disable or it globally or to override it per operation. This is commonly used to disable the Explorer for destructive operations, payment processing, or admin-only endpoints.
The [API Explorer](/learn/docs/api-references/api-explorer) is enabled by default for all endpoints. Use `x-fern-explorer` to disable or it globally or to override it per operation. This is commonly used to disable the Explorer for destructive operations, payment processing, or admin-only endpoints.

## Global

Expand Down Expand Up @@ -55,4 +55,4 @@ paths:
post:
operationId: charge_payment
# Remains disabled (global setting applies)
```
```
41 changes: 23 additions & 18 deletions fern/products/docs/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -255,13 +255,9 @@ navigation:
path: ./pages/api-references/sdk-snippets.mdx
- page: HTTP snippets
path: ./pages/api-references/http-snippets.mdx
- section: API Explorer
- page: API Explorer
path: ./pages/api-references/api-explorer.mdx
slug: api-explorer
contents:
- page: Overview
path: ./pages/api-references/api-explorer.mdx
- page: Auto-populate API keys
path: ./pages/api-references/autopopulate-api-key.mdx
- page: Audiences
path: ./pages/api-references/audiences.mdx
- page: Customize API Reference layout
Expand Down Expand Up @@ -294,18 +290,27 @@ navigation:
contents:
- page: Overview
path: ./pages/authentication/overview.mdx
- page: Role based access control (RBAC)
path: ./pages/authentication/rbac.mdx
slug: rbac
- page: Set up OAuth for RBAC
path: ./pages/authentication/set-up-oauth.mdx
slug: set-up-oauth
- page: API key injection
path: ./pages/api-references/autopopulate-api-key.mdx
- page: SSO
path: ./pages/authentication/sso.mdx
- page: Password protection
path: ./pages/authentication/password.mdx
- section: Setup
slug: setup
contents:
- page: Password protection
path: ./pages/authentication/password.mdx
- page: SSO
path: ./pages/authentication/sso.mdx
- page: JWT
path: ./pages/authentication/jwt-setup.mdx
slug: jwt
- page: OAuth
path: ./pages/authentication/oauth-setup.mdx
slug: oauth
- section: Features
slug: features
contents:
- page: Role-based access control (RBAC)
path: ./pages/authentication/rbac.mdx
slug: rbac
- page: API key injection
path: ./pages/authentication/api-key-injection.mdx
- section: Security
collapsed: true
contents:
Expand Down
2 changes: 2 additions & 0 deletions fern/products/docs/pages/api-references/api-explorer.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ Once a user sets their authentication credentials, their credentials persist thr
Authentication credentials are only stored client-side using cookies. No sensitive user information is collected or stored.
</Info>

To automatically populate API keys for logged-in users, see [API key injection](/learn/docs/authentication/features/api-key-injection).

## Multiple environments

When multiple server URLs are configured in [OpenAPI](/learn/api-definitions/openapi/extensions/server-names) or the [Fern Definition](/learn/api-definition/fern/api-yml/environments), users can switch between environments (e.g., production and sandbox) from a dropdown in the API Explorer. The selected environment persists as they navigate between pages.
Expand Down
Loading
Loading