Document read-only API spec files in web editor#4908
Merged
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
ethanpalm
reviewed
Mar 31, 2026
ethanpalm
approved these changes
Mar 31, 2026
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
1 participant
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
API spec files can now be viewed but not edited directly in the web editor. Users who need to update spec files should edit them in their repository using their preferred code editor.
Note
Low Risk
Low risk documentation-only change with no runtime or behavior modifications.
Overview
Updates
editor/pages.mdxto add a Note under Edit content stating that API specification files (OpenAPI/AsyncAPI) are read-only in the web editor and must be edited in a local code editor and pushed to the docs repository.Written by Cursor Bugbot for commit 9cef361. This will update automatically on new commits. Configure here.