Skip to content

Update from code changes: document OpenAPI file uploads - #6863

Merged
ethanpalm merged 6 commits into
mainfrom
mintlify/openapi-31-file-uploads-docs
Aug 10, 2026
Merged

Update from code changes: document OpenAPI file uploads#6863
ethanpalm merged 6 commits into
mainfrom
mintlify/openapi-31-file-uploads-docs

Conversation

@mintlify

@mintlify mintlify Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Summary

Document OpenAPI 3.1 file-upload schemas and their API Playground behavior.

Changes

  • Explain contentMediaType and optional contentEncoding configuration.
  • Add a multipart/form-data request-body example and clarify supported media types.
  • Update English, Spanish, French, and Chinese setup pages.

Source change: https://github.com/mintlify/mint/pull/9788


Note

Low Risk
Documentation-only changes to MDX guides with no runtime or security impact.

Overview
Adds a Configure file uploads section to the OpenAPI setup guide (English, Spanish, French, and Chinese), placed after base URL / servers configuration and before authentication.

The new content explains how OpenAPI 3.1 multipart file fields work in the API playground: string schemas with a binary contentMediaType, optional contentEncoding (including base64 / base64url vs binary handling), a multipart/form-data JSON example, which MIME types count as uploads, and that legacy format: "binary" / format: "base64" remain supported. Localized pages use a configure-file-uploads anchor where the English page uses a plain heading. The Chinese page also expands the frontmatter description to mention file uploads and related setup topics.

Reviewed by Cursor Bugbot for commit 9ac2a0d. Bugbot is set up for automated code reviews on this repo. Configure here.

Mintlify

2 threads from 1 user in Mintlify

Review in Mintlify

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Aug 4, 2026, 8:46 PM
tomee 🟢 Ready View Preview Aug 4, 2026, 8:46 PM

Update history

  • 2026-08-05: Appended base64 and base64url file-encoding behavior to the English, Spanish, French, and Chinese setup pages for mintlify/server#7232.

@mintlify

mintlify Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
mintlify 🔴 Failed Aug 10, 2026, 10:20 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Aug 4, 2026

Copy link
Copy Markdown
Contributor Author

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

Project Status Preview Updated (UTC)
tomee 🟢 Ready View Preview Aug 4, 2026, 8:46 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify

mintlify Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor Author

Update from code changes updated this PR.

Updated localized upload terminology, SEO metadata, and prose consistency

Source PRs

Comment thread api-playground/openapi-setup.mdx Outdated
@mintlify-development

mintlify-development Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
userauth 🔴 Failed Aug 10, 2026, 9:26 PM

@mintlify-development

mintlify-development Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
prosignuptest 🔴 Failed Aug 10, 2026, 10:20 PM

@mintlify-development

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
mintlify 🟡 Building Aug 10, 2026, 9:20 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@mintlify-development

mintlify-development Bot commented Aug 10, 2026

Copy link
Copy Markdown
Contributor

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

Project Status Preview Updated (UTC)
testing 🔴 Failed Aug 10, 2026, 9:37 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@ethanpalm
ethanpalm merged commit 0f449bc into main Aug 10, 2026
6 checks passed
@ethanpalm
ethanpalm deleted the mintlify/openapi-31-file-uploads-docs branch August 10, 2026 21:20
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