Skip to content

Commit 332466e

Browse files
thesandlordSandeep Dinesh
andauthored
docs: remove x-fern-explorer-enabled from docs (#2024)
Co-authored-by: Sandeep Dinesh <[email protected]>
1 parent 3e7cb2b commit 332466e

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

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

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
title: API Explorer control
3-
description: Enable or disable the API Explorer using `x-fern-explorer` and `x-fern-explorer-enabled`
3+
description: Enable or disable the API Explorer using `x-fern-explorer`
44
---
55

6-
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.
6+
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.
77

88
## Global
99

@@ -23,16 +23,16 @@ paths:
2323
2424
## Endpoint
2525
26-
To control the API Explorer for individual endpoints, use `x-fern-explorer-enabled`:
26+
To control the API Explorer for individual endpoints, use `x-fern-explorer`:
2727

2828
```yaml title="openapi.yml" {4,9}
2929
paths:
3030
/payments:
3131
get:
32-
x-fern-explorer-enabled: true # Enable Explorer for safe read operation
32+
x-fern-explorer: true # Enable Explorer for safe read operation
3333
/payments/charge:
3434
post:
35-
x-fern-explorer-enabled: false # Disable to prevent accidental transactions
35+
x-fern-explorer: false # Disable to prevent accidental transactions
3636
```
3737

3838
## Combining global and endpoint-level settings
@@ -49,7 +49,7 @@ paths:
4949
/payments:
5050
get:
5151
operationId: list_payments
52-
x-fern-explorer-enabled: true # Enable Explorer for safe read operation
52+
x-fern-explorer: true # Enable Explorer for safe read operation
5353
/payments/charge:
5454
post:
5555
operationId: charge_payment

0 commit comments

Comments
 (0)