Skip to content

Document OpenAPI 3.2 support - #7436

Draft
brandonmcconnell wants to merge 7 commits into
mainfrom
cursor/eng-11064-openapi-3-2-docs-9943
Draft

brandonmcconnell wants to merge 7 commits into
mainfrom
cursor/eng-11064-openapi-3-2-docs-9943

Conversation

@brandonmcconnell

@brandonmcconnell brandonmcconnell commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor

Documentation changes

Adds an OpenAPI 3.2 features section to api-playground/openapi-setup.mdx and updates the supported-version statements to include 3.2. Covers:

  • tag hierarchies
  • query and additionalOperations, including the frontmatter form for custom methods
  • in: querystring
  • itemSchema streaming
  • dataValue / serializedValue
  • device authorization and the other security scheme additions
  • defaultMapping
  • serialization rules: style: cookie, allowReserved, positional encodings, and header names
  • document-level fields: $self, servers[].name, response summary, components.mediaTypes
  • the documented limitations

Also:

  • Tag hierarchies get their own Nested groups from tag hierarchies section next to Group display names. It's carried over from docs#7693, which the Mintlify app opened from mint#10975, so Update from code changes: OpenAPI 3.2 tag hierarchies #7693 can be closed. It adds two details from the merged code: undeclared tags are the last fallback for placement, and kind values other than nav and badge create neither groups nor pills.
  • Updated for the merged stack:
    • defaultMapping must be one of the oneOf/anyOf variants when the schema lists them.
    • Header parameter names and headers map keys must be RFC 9110 field names.
    • multipart/mixed and multipart/related bodies are sent as one framed message, so the FormData limitation now applies only to multipart/form-data.
  • The same changes are translated into es, fr, and zh. Each translated heading keeps its English anchor in a <div id> wrapper, as the rest of these pages do.

Merge after the server picks up the published packages. The mint stack (#11550 → #11562) has merged. 3.2 documents are accepted once server#8382 is merged with the bumped packages and deployed.

Closes ENG-11064 (docs portion)


For Reviewers

When reviewing documentation PRs, please consider:

✅ Technical accuracy

  • Code examples work as written (each YAML/MDX snippet mirrors a fixture in the mint stack's tests)
  • Commands and configurations are correct
  • Links resolve to the right destinations (mint broken-links passes)
  • Prerequisites and requirements are accurate

✅ Clarity and completeness

  • Instructions are clear and easy to follow
  • Steps are in logical order
  • Nothing important is missing
  • Examples help illustrate the concepts

✅ User experience

  • A new user could follow these docs successfully
  • Common gotchas or edge cases are addressed (Limitations subsection)
  • Error messages or troubleshooting guidance is helpful
Open in Web Open in Cursor 

@mintlify

mintlify Bot commented Sep 21, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
mintlify 🟢 Ready View Preview Oct 3, 2026, 10:36 PM

@cursor

cursor Bot commented Sep 25, 2026

Copy link
Copy Markdown

@greptileai
/devin review
bugbot run

Re-review requested: prior findings were addressed in follow-up commits.

@cursor

cursor Bot commented Sep 26, 2026

Copy link
Copy Markdown

/devin review
bugbot run
@greptileai

cursoragent and others added 7 commits October 3, 2026 22:31
Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
…for-byte behavior

Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
…fields are accepted without checks

Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
…ction for the merged mint stack

Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>

This branch was successfully deployed

1 active deployment
staging — 9d19fae4 Deployed Oct 3, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants