Update from code changes: document OpenAPI file uploads - #6863
Open
mintlify[bot] wants to merge 5 commits into
Open
Update from code changes: document OpenAPI file uploads#6863mintlify[bot] wants to merge 5 commits into
mintlify[bot] wants to merge 5 commits 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. |
Contributor
Author
|
Update from code changes updated this PR. Updated localized upload terminology, SEO metadata, and prose consistency Source PRs
|
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
Document OpenAPI 3.1 file-upload schemas and their API Playground behavior.
Changes
contentMediaTypeand optionalcontentEncodingconfiguration.multipart/form-datarequest-body example and clarify supported media types.Source change: https://github.com/mintlify/mint/pull/9788
Note
Low Risk
Documentation-only changes to MDX guides with no application or API code modified.
Overview
Adds a Configure file uploads section to
openapi-setup(English, Spanish, French, and Chinese), placed before authentication setup.The new content documents OpenAPI 3.1 multipart file fields: string schemas with binary
contentMediaType, optionalcontentEncoding(includingbase64/base64urlvs binary handling), amultipart/form-dataJSON example, supported MIME types, and continued support for legacyformat: "binary"andformat: "base64". Localized pages use aconfigure-file-uploadsanchor; the Chinese page also expands its frontmatterdescriptionto mention file uploads.Reviewed by Cursor Bugbot for commit ea77b6d. Bugbot is set up for automated code reviews on this repo. Configure here.
Mintlify
2 threads from 1 user in Mintlify
Preview deployment for your docs. Learn more about Mintlify Previews.
Update history