Skip to content

Clarify automatic OpenAPI page generation - #7159

Closed
hamedrabah wants to merge 1 commit into
mintlify:mainfrom
hamedrabah:docs/openapi-generation
Closed

Clarify automatic OpenAPI page generation#7159
hamedrabah wants to merge 1 commit into
mintlify:mainfrom
hamedrabah:docs/openapi-generation

Conversation

@hamedrabah

@hamedrabah hamedrabah commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Documentation changes

Updates the OpenAPI setup guide to make the current workflow explicit:

  • Endpoint pages generate automatically during a Mintlify build.
  • Users should run mint validate and mint dev after referencing the specification.
  • The former @mintlify/scraping openapi-file command is no longer supported and scraping is for importing existing documentation websites.

Closes #316

Validation

  • mint validate --telemetry=false
  • mint broken-links --files api-playground/openapi-setup.mdx --telemetry=false
  • git diff --check

Note

Low Risk
Documentation-only change to openapi-setup.mdx with 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 validate and mint dev after adding the spec reference, and states that npx @mintlify/scraping openapi-file is no longer supported for this flow—@mintlify/scraping is 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.

@ethanpalm ethanpalm closed this Aug 27, 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.

Generating from OpenAPI Error: Unknown commands: openapi-file

2 participants