Document markdown.schema config for AI markdown export#5577
Closed
mintlify[bot] wants to merge 1 commit intomainfrom
Closed
Document markdown.schema config for AI markdown export#5577mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Generated-By: mintlify-agent
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Collaborator
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
2 participants
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
A recent platform change makes it configurable whether the full OpenAPI/AsyncAPI specification is included in the per-page Markdown served to AI agents on API reference pages. The behavior is controlled by a new
markdown.schemafield indocs.json(defaults totrue). When set tofalse, API reference Markdown exports omit the inline specification and instead link to the site'sllms.txtindex.Changes
ai/markdown-export.mdxexplaining what the option does, when to use it, and adocs.jsonexample.Translations were intentionally not updated; they are handled separately.
Note
Low Risk
Documentation-only change that explains a new config flag; no runtime or security-impacting code paths are modified.
Overview
Adds an API specification inclusion section to
ai/markdown-export.mdxdescribing the default behavior of inlining OpenAPI/AsyncAPI endpoint specs in Markdown exports and how to disable it viamarkdown.schema: falseindocs.json(falling back to linkingllms.txt).Reviewed by Cursor Bugbot for commit 1fa6595. Bugbot is set up for automated code reviews on this repo. Configure here.