Document configurable API spec inclusion in Markdown export#5575
Closed
mintlify[bot] wants to merge 1 commit intomainfrom
Closed
Document configurable API spec inclusion in Markdown export#5575mintlify[bot] wants to merge 1 commit intomainfrom
mintlify[bot] wants to merge 1 commit intomainfrom
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Collaborator
|
Closing: no evidence this feature has shipped to production. The |
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
Documents the new
markdown.schemasetting indocs.json, which controls whether the full OpenAPI or AsyncAPI specification is embedded in the Markdown version of API reference pages served to AI agents. Defaults totrue. When set tofalse, the specification is omitted and replaced with a link tollms.txt.Source change
Triggering PR shipped a new
markdownconfiguration object on the docs config schema with a single boolean property,schema, that toggles inclusion of the full OpenAPI/AsyncAPI YAML in.mdexports of API reference pages.Changes
ai/markdown-export.mdx: Added an "API specifications in Markdown export" section explaining the default behavior, the newmarkdown.schemaoption, and its effect on Markdown output.organize/settings-reference.mdx: Addedmarkdownandmarkdown.schemaentries to both the quick reference table and the full property reference.Note
Low Risk
Documentation-only changes describing a new
docs.jsonoption; no runtime behavior or security-sensitive code is modified.Overview
Documents a new
docs.jsontoggle,markdown.schema, that controls whether API reference Markdown exports embed full OpenAPI/AsyncAPI specs or instead link agents tollms.txtwhen disabled.Updates the Markdown export guide with the new behavior, example config, and a small value/behavior table, and adds
markdown.schemato thedocs.jsonsettings quick reference and full schema reference.Reviewed by Cursor Bugbot for commit 7c13d5f. Bugbot is set up for automated code reviews on this repo. Configure here.