Update from code changes: document x-mint playground expand setting - #7202
Open
mintlify[bot] wants to merge 1 commit into
Open
Update from code changes: document x-mint playground expand setting#7202mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit 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
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 operation-level
x-mint.playground.expandOpenAPI extension for collapsing nested object fields in the API playground by default.Spec authors can now add
x-mint: playgroundwithexpand: falseto an operation so nested object field dropdowns start collapsed in the API playground. Top-level request sections (Authorization, Path, Query, Body) always stay expanded, and users can still expand collapsed fields manually. When the setting is omitted, behavior is unchanged and everything starts expanded. Shipped in https://github.com/mintlify/mint/pull/10537Changes
x-mintcustomization docs on the OpenAPI setup page, with a JSON exampleNote
Low Risk
Documentation-only changes to MDX; no runtime or API behavior in this repo.
Overview
Documents the operation-level
x-mint.playground.expandOpenAPI extension so authors can start nested object fields collapsed in the API playground.A new Collapse nested playground fields section on the OpenAPI setup page explains setting
expand: falseunderx-mint.playground, includes a JSON example, and clarifies that top-level sections (Authorization, Path, Query, Body) stay expanded while only nested object fields collapse; omittingexpandkeeps today’s all-expanded default. The same section is added to the Spanish, French, and Chineseopenapi-setuppages (localized locales use acollapse-nested-playground-fieldsanchor for deep links).Reviewed by Cursor Bugbot for commit c400a77. Bugbot is set up for automated code reviews on this repo. Configure here.