Update from code changes: document x-mint playground expand setting - #7202
Update from code changes: document x-mint playground expand setting#7202mintlify[bot] wants to merge 2 commits into
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
- Updated api-playground/openapi-setup.mdx Mintlify-Source: dashboard-editor
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes using default effort and found 2 potential issues.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 21accc0. Configure here.
|
|
||
| OpenAPI is a specification for describing APIs. Mintlify supports OpenAPI 3.0 and 3.1 documents to generate interactive API documentation and keep it up to date. | ||
|
|
||
|  |
There was a problem hiding this comment.
Accidental favicon image in docs
Medium Severity
A Favicon image was inserted at the top of the OpenAPI setup page. It is unrelated to the x-mint.playground.expand documentation and will render on the live page.
Reviewed by Cursor Bugbot for commit 21accc0. Configure here.
| | | | | | ||
| | --- | --- | --- | | ||
| | | | | | ||
| | | | | |
There was a problem hiding this comment.
Empty table added to docs
Medium Severity
An empty three-column markdown table was inserted near the top of the OpenAPI setup page. It has no headers or content and will render as a blank table on the live page.
Reviewed by Cursor Bugbot for commit 21accc0. Configure here.


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 with no runtime or auth impact; the favicon/table additions may be accidental editorial noise.
Overview
Documents the operation-level
x-mint.playground.expandOpenAPI extension so nested object fields in the API playground can start collapsed.The English OpenAPI setup page adds a Collapse nested playground fields section (JSON example plus behavior: top-level Authorization/Path/Query/Body stay expanded, nested objects collapse when
expand: false, default remains fully expanded). The same section is mirrored in the Spanish, French, and Chineseopenapi-setuppages.The English page also updates several code fences from
{line}tohighlight={line}syntax, reformats some<CodeGroup>/<Steps>JSON blocks, and expands frontmatterkeywordsto a YAML list. The diff includes a favicon image and empty markdown table near the top of the English page—worth confirming those are intentional before merge.Reviewed by Cursor Bugbot for commit 21accc0. Bugbot is set up for automated code reviews on this repo. Configure here.
Mintlify
1 thread from 1 user in Mintlify