docs: OpenAPI Overlay support - #7261
Closed
brandonmcconnell wants to merge 1 commit into
Closed
Conversation
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
…s auto-discovery, precedence, actions) Co-authored-by: Cursor <cursoragent@cursor.com>
brandonmcconnell
force-pushed
the
brandon/openapi-overlays
branch
from
September 5, 2026 10:37
7402af4 to
7346d10
Compare
brandonmcconnell
added a commit
that referenced
this pull request
Sep 6, 2026
Consolidates the two overlay docs PRs into this one. Keeps this PR's structure and anchors (already referenced from the glossary, settings pages, and translations), tightens the prose toward the page's voice, leads with "Use OpenAPI Overlays to...", drops repeated "Mintlify" subjects, and renames the example heading to "Rename a path" to match the page's imperative headings. fr/es/zh mirrors updated to match. Co-authored-by: Cursor <cursoragent@cursor.com>
Contributor
Author
|
Superseded by #7282, which now includes the wording from this PR plus the glossary entry and fr/es/zh translations. |
brandonmcconnell
added a commit
that referenced
this pull request
Sep 6, 2026
* docs: document OpenAPI overlay support * docs: translate OpenAPI overlay docs to fr, es, zh and trim zh description * docs: describe overlay failure behavior on hosted deployments * docs: tighten overlay section and merge in wording from #7261 Consolidates the two overlay docs PRs into this one. Keeps this PR's structure and anchors (already referenced from the glossary, settings pages, and translations), tightens the prose toward the page's voice, leads with "Use OpenAPI Overlays to...", drops repeated "Mintlify" subjects, and renames the example heading to "Rename a path" to match the page's imperative headings. fr/es/zh mirrors updated to match. Co-authored-by: Cursor <cursoragent@cursor.com> --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com> Co-authored-by: brandonmcconnell <brandon@mintlify.com> Co-authored-by: Cursor <cursoragent@cursor.com>
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 OpenAPI Overlay 1.1.0 support (feature PR: mintlify/mint#10770).
Changes
api-playground/openapi-setup.mdx— new "Apply OpenAPI Overlays" section: what overlays are, theoverlaysproperty indocs.json(including array-of-objects form), auto-discovery viaextends, precedence and ordering rules, empty-list opt-out, supported actions including 1.1.0copy, RFC 9535 JSONPath note, a rename example (update+copy+remove) with aserversupdate, the note that MDXopenapi:frontmatter must reference post-overlay paths, andmint validatebehavior.organize/settings-api.mdx—overlaysfield on theapi.openapiobject with an example.organize/settings-reference.mdx— updatedapi.openapitype signature.mint broken-linkspasses.Merge timing
Should land alongside or after mintlify/mint#10770 so the docs don't describe an unreleased feature.
Made with Cursor