Document OpenAPI 3.2 support - #7436
Draft
brandonmcconnell wants to merge 5 commits into
Draft
brandonmcconnell wants to merge 5 commits into
brandonmcconnell wants to merge 5 commits into
Conversation
Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
|
@greptileai Re-review requested: prior findings were addressed in follow-up commits. |
|
/devin review |
…for-byte behavior Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
…fields are accepted without checks Co-authored-by: Brandon McConnell <brandon@dreamthinkbuild.com>
This branch was successfully deployed
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.
Documentation changes
Adds an OpenAPI 3.2 features section to
api-playground/openapi-setup.mdxand updates the supported-version statements to include 3.2. Covers tag hierarchies,queryandadditionalOperations(including the frontmatter form for custom methods),in: querystring,itemSchemastreaming,dataValue/serializedValue, device authorization and other security scheme additions,defaultMapping, serialization rules (style: cookie,allowReserved, positional encodings), document-level fields ($self,servers[].name, responsesummary,components.mediaTypes), and the documented limitations from the coverage matrix in mint#11562.Hold until the mint stack has merged and the server has picked up the published packages. There is no feature flag: 3.2 documents are accepted by their declared version once the mint stack (#11550 → #11562) and server#8382 are deployed; merging this earlier would document behavior customers cannot yet use. Features that merge later in the stack can be documented incrementally if the stack lands in pieces.
Closes ENG-11064 (docs portion)
For Reviewers
When reviewing documentation PRs, please consider:
✅ Technical accuracy
✅ Clarity and completeness
✅ User experience