Document new "auth" playground display type #2976
Closed
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.
Added documentation for the new
playground: "auth"display type that dynamically shows the interactive API playground based on user authentication and group membership. This feature allows restricting interactive API testing to specific user groups while still allowing page visibility.Files changed
api-playground/overview.mdx- Added "auth" to display type options and included new section with examplesapi-playground/mdx-setup.mdx- Added "auth" to playground options list with detailed usage examplesGenerated from feat: add "auth" display type for playground @lawreka
Note
Low Risk
Documentation-only changes that don’t affect runtime behavior; primary risk is minor user confusion if wording/metadata examples are incorrect.
Overview
Documents a new
playground: "auth"/playground: 'auth'display mode for the API playground in both thedocs.jsonconfiguration (api.playground.display) and per-page frontmatter.Adds an authentication + groups-based visibility section with an example using
public: trueandgroups, and clarifies the resulting behavior (interactive for matching authenticated users, hidden otherwise).Written by Cursor Bugbot for commit ccfb322. This will update automatically on new commits. Configure here.