Document playground.hidden option on customize-api-reference-layout page - #7194
Open
fern-api[bot] wants to merge 1 commit into
Open
fern-api[bot] wants to merge 1 commit into
fern-api[bot] wants to merge 1 commit into
Conversation
fern-api
Bot
requested review from
jkonrath-postman and
nerminamiller-postman
as code owners
September 30, 2026 17:16
| ### Setting API Explorer options | ||
|
|
||
| The `playground` property sets three API Explorer options: `oauth` enables the [OAuth client-credentials flow](/learn/api-definitions/openapi/authentication), `environments` restricts which server environments are available (an empty list disables the Explorer), and `send-optional-defaults` [pre-fills and sends the declared defaults](/learn/docs/api-references/api-explorer#autopopulate-with-examples) of optional parameters. Set it on the `- api` entry to apply a default across all endpoints, then override it on a section or endpoint in `layout`: | ||
| The `playground` property sets four API Explorer options: `oauth` enables the [OAuth client-credentials flow](/learn/api-definitions/openapi/authentication), `environments` restricts which server environments are available (an empty list disables the Explorer), `send-optional-defaults` [pre-fills and sends the declared defaults](/learn/docs/api-references/api-explorer#autopopulate-with-examples) of optional parameters, and `hidden: true` hides the Try it button for every endpoint under the API reference (the Explorer is not shown at all). Set it on the `- api` entry to apply a default across all endpoints, then override it on a section or endpoint in `layout`: |
Contributor
There was a problem hiding this comment.
🚫 [vale] <FernStyles.Reject> reported by reviewdog 🐶
Use 'API Reference' instead of 'API reference'.
| ### Setting API Explorer options | ||
|
|
||
| The `playground` property sets three API Explorer options: `oauth` enables the [OAuth client-credentials flow](/learn/api-definitions/openapi/authentication), `environments` restricts which server environments are available (an empty list disables the Explorer), and `send-optional-defaults` [pre-fills and sends the declared defaults](/learn/docs/api-references/api-explorer#autopopulate-with-examples) of optional parameters. Set it on the `- api` entry to apply a default across all endpoints, then override it on a section or endpoint in `layout`: | ||
| The `playground` property sets four API Explorer options: `oauth` enables the [OAuth client-credentials flow](/learn/api-definitions/openapi/authentication), `environments` restricts which server environments are available (an empty list disables the Explorer), `send-optional-defaults` [pre-fills and sends the declared defaults](/learn/docs/api-references/api-explorer#autopopulate-with-examples) of optional parameters, and `hidden: true` hides the Try it button for every endpoint under the API reference (the Explorer is not shown at all). Set it on the `- api` entry to apply a default across all endpoints, then override it on a section or endpoint in `layout`: |
Contributor
There was a problem hiding this comment.
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'isn't' instead of 'is not'.
Suggested change
| The `playground` property sets four API Explorer options: `oauth` enables the [OAuth client-credentials flow](/learn/api-definitions/openapi/authentication), `environments` restricts which server environments are available (an empty list disables the Explorer), `send-optional-defaults` [pre-fills and sends the declared defaults](/learn/docs/api-references/api-explorer#autopopulate-with-examples) of optional parameters, and `hidden: true` hides the Try it button for every endpoint under the API reference (the Explorer is not shown at all). Set it on the `- api` entry to apply a default across all endpoints, then override it on a section or endpoint in `layout`: | |
| The `playground` property sets four API Explorer options: `oauth` enables the [OAuth client-credentials flow](/learn/api-definitions/openapi/authentication), `environments` restricts which server environments are available (an empty list disables the Explorer), `send-optional-defaults` [pre-fills and sends the declared defaults](/learn/docs/api-references/api-explorer#autopopulate-with-examples) of optional parameters, and `hidden: true` hides the Try it button for every endpoint under the API reference (the Explorer isn't shown at all). Set it on the `- api` entry to apply a default across all endpoints, then override it on a section or endpoint in `layout`: |
| </ParamField> | ||
|
|
||
| <ParamField path="playground.hidden" toc={true} type="boolean"> | ||
| When `true`, hides the Try it button for every endpoint in this API section. The API Explorer is not shown. Can also be set on individual sections or endpoints in `layout` to override. |
Contributor
There was a problem hiding this comment.
🚫 [vale] <Microsoft.Contractions> reported by reviewdog 🐶
Use 'isn't' instead of 'is not'.
Suggested change
| When `true`, hides the Try it button for every endpoint in this API section. The API Explorer is not shown. Can also be set on individual sections or endpoints in `layout` to override. | |
| When `true`, hides the Try it button for every endpoint in this API section. The API Explorer isn't shown. Can also be set on individual sections or endpoints in `layout` to override. |
Contributor
|
🌿 Preview your docs: https://fern-preview-2026-09-30-fern-ai-1fb7a4-37e3e6a3.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
On the "Customize API Reference layout" page, updated the "Setting API Explorer options" section to mention
hiddenas a fourthplaygroundsub-property (alongsideoauth,environments, andsend-optional-defaults), updated the prose description accordingly, added a standalone YAML example showingplayground: hidden: trueon an- apientry, and added a new<ParamField path="playground.hidden" toc={true} type="boolean">entry in the configuration options reference afterplayground.send-optional-defaults.