Skip to content

docs: remove x-fern-explorer-enabled from docs #2024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 14, 2025
Merged

docs: remove x-fern-explorer-enabled from docs #2024

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions fern/products/api-def/openapi-pages/extensions/explorer.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
title: API Explorer control
description: Enable or disable the API Explorer using `x-fern-explorer` and `x-fern-explorer-enabled`
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 it globally, or `x-fern-explorer-enabled` to control 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/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.

## Global

Expand All @@ -23,16 +23,16 @@ paths:

## Endpoint

To control the API Explorer for individual endpoints, use `x-fern-explorer-enabled`:
To control the API Explorer for individual endpoints, use `x-fern-explorer`:

```yaml title="openapi.yml" {4,9}
paths:
/payments:
get:
x-fern-explorer-enabled: true # Enable Explorer for safe read operation
x-fern-explorer: true # Enable Explorer for safe read operation
/payments/charge:
post:
x-fern-explorer-enabled: false # Disable to prevent accidental transactions
x-fern-explorer: false # Disable to prevent accidental transactions
```

## Combining global and endpoint-level settings
Expand All @@ -49,7 +49,7 @@ paths:
/payments:
get:
operationId: list_payments
x-fern-explorer-enabled: true # Enable Explorer for safe read operation
x-fern-explorer: true # Enable Explorer for safe read operation
/payments/charge:
post:
operationId: charge_payment
Expand Down