Clarify automatic OpenAPI page generation - #7159
Closed
hamedrabah wants to merge 1 commit into
Closed
Conversation
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.
Documentation changes
Updates the OpenAPI setup guide to make the current workflow explicit:
Closes #316
Validation
Note
Low Risk
Documentation-only change to
openapi-setup.mdxwith no product or runtime impact.Overview
Adds a Generate endpoint pages section early in the OpenAPI setup guide so the default workflow is explicit: endpoint pages are created when Mintlify builds docs after you wire the spec into
docs.json, with no separate MDX generation step.The new text tells readers to run
mint validateandmint devafter adding the spec reference, and states thatnpx @mintlify/scraping openapi-fileis no longer supported for this flow—@mintlify/scrapingis only for importing existing documentation sites, not OpenAPI-driven page generation.Reviewed by Cursor Bugbot for commit d58e261. Bugbot is set up for automated code reviews on this repo. Configure here.