Skip to content

Document localhost OpenAPI previews - #7156

Merged
ethanpalm merged 1 commit into
mintlify:mainfrom
hamedrabah:docs/localhost-openapi
Sep 14, 2026
Merged

ethanpalm merged 1 commit into
mintlify:mainfrom
hamedrabah:docs/localhost-openapi

Conversation

@hamedrabah

@hamedrabah hamedrabah commented Aug 27, 2026

Copy link
Copy Markdown
Contributor

Documentation changes

Documents the existing local OpenAPI workflow:

  • Reference a specification served from localhost in docs.json.
  • Run mint dev with --local-schema.
  • Use the same flag with mint validate.
  • Keep HTTPS as the production requirement.

Closes #617

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 with no runtime, auth, or data-handling impact.

Overview
Adds a Use a localhost specification section to the OpenAPI setup guide so developers can preview API docs against a spec served from their machine during local work.

The new content shows pointing navigation.openapi at a http://localhost:… URL, running mint dev --local-schema so the CLI can fetch that spec over HTTP, and the same --local-schema flag with mint validate when checking config without a dev server. It also states that production OpenAPI URLs must use HTTPS.

Reviewed by Cursor Bugbot for commit d1bbaee. Bugbot is set up for automated code reviews on this repo. Configure here.

@ethanpalm ethanpalm left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for creating this PR, @hamedrabah. Appreciate you taking the time to improve the Mintlify docs.

@ethanpalm
ethanpalm merged commit 904f27f into mintlify:main Sep 14, 2026
2 checks passed
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.

Allow localhost openapi files

2 participants