Update from code changes: document API Playground variables - #6882
Open
mintlify[bot] wants to merge 2 commits into
Open
Update from code changes: document API Playground variables#6882mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
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
1 participant
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.
Summary
Documents the new client API for pre-filling OpenAPI API Playground server variables from custom JavaScript.
Changes
Context
The triggering source change exposes these methods under
window.mintlify.api.playground.https://github.com/mintlify/mint/pull/9823
Note
Low Risk
Documentation-only changes to MDX; no application or runtime code is modified.
Overview
Documents how custom JavaScript can drive OpenAPI API Playground server variables via
window.mintlify.api.playground.setServerVariablesandclearServerVariables, including English, Spanish, French, and Chinese updates to Custom scripts.The new section explains post-load use cases (auth SDK init, tenant changes), that each
setServerVariablescall replaces the full in-memory override (omitted keys drop off), runtime values beat OpenAPI defaults and saved values, and clear restores configured fallbacks. It also notes pre-init queuing, updates to open and future playgrounds, session-only storage (nolocalStorage/credentials; refresh clears), and a warning to use non-secret values only.Page description and keywords are extended to mention API Playground server variables.
Reviewed by Cursor Bugbot for commit 128da93. Bugbot is set up for automated code reviews on this repo. Configure here.