Skip to content

Document configurable API spec inclusion in Markdown export#5575

Closed
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/markdown-schema-config-1777412282
Closed

Document configurable API spec inclusion in Markdown export#5575
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/markdown-schema-config-1777412282

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify Bot commented Apr 28, 2026

Summary

Documents the new markdown.schema setting in docs.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 to true. When set to false, the specification is omitted and replaced with a link to llms.txt.

Source change

Triggering PR shipped a new markdown configuration object on the docs config schema with a single boolean property, schema, that toggles inclusion of the full OpenAPI/AsyncAPI YAML in .md exports of API reference pages.

Changes

  • ai/markdown-export.mdx: Added an "API specifications in Markdown export" section explaining the default behavior, the new markdown.schema option, and its effect on Markdown output.
  • organize/settings-reference.mdx: Added markdown and markdown.schema entries to both the quick reference table and the full property reference.

Note

Low Risk
Documentation-only changes describing a new docs.json option; no runtime behavior or security-sensitive code is modified.

Overview
Documents a new docs.json toggle, markdown.schema, that controls whether API reference Markdown exports embed full OpenAPI/AsyncAPI specs or instead link agents to llms.txt when disabled.

Updates the Markdown export guide with the new behavior, example config, and a small value/behavior table, and adds markdown.schema to the docs.json settings 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.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify Bot commented Apr 28, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 28, 2026, 9:42 PM

@ethanpalm
Copy link
Copy Markdown
Collaborator

Closing: no evidence this feature has shipped to production. The markdown.schema config field does not appear in the docs.json validation schema (v2 properties), the server config parsing, or any recent commits to main in mintlify/server or mintlify/mint. If this feature ships in the future, a new docs PR can be opened at that time.

@ethanpalm ethanpalm closed this Apr 28, 2026
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.

1 participant