Document API spec file upload in web editor#5222
Open
mintlify[bot] wants to merge 1 commit intomainfrom
Open
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
What shipped
The web editor now supports uploading API specification files (OpenAPI and AsyncAPI) in
.json,.yaml, and.ymlformats directly from the editor. Previously, updating spec files required editing them externally and pushing via Git. The publish flow was also improved with snapshot-based publishing for better reliability.Note
Low Risk
Low risk documentation-only updates that clarify existing web editor behavior around API spec uploads and what counts as a pending change.
Overview
Updates web editor docs to clarify that OpenAPI/AsyncAPI spec files remain read-only for inline editing but can now be replaced by uploading a new file via the editor (
editor/pages.mdx).Clarifies in the publishing docs that file uploads, including API specification files, are tracked as pending changes (
editor/publish.mdx).Reviewed by Cursor Bugbot for commit 1365b7c. Bugbot is set up for automated code reviews on this repo. Configure here.