Skip to content

Deprecate openapi-check in favor of validate#5109

Closed
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/deprecate-openapi-check-1775177051
Closed

Deprecate openapi-check in favor of validate#5109
mintlify[bot] wants to merge 1 commit intomainfrom
mintlify/deprecate-openapi-check-1775177051

Conversation

@mintlify
Copy link
Copy Markdown
Contributor

@mintlify mintlify bot commented Apr 3, 2026

Summary

The openapi-check CLI command is now deprecated. The validate command now automatically validates OpenAPI specifications referenced in docs.json.

  • Marked openapi-check as deprecated with a warning pointing users to mint validate
  • Updated validate command docs to describe automatic OpenAPI spec validation and the new --local-schema flag
  • Updated all references to mint openapi-check across API playground docs to use mint validate instead

Note

Low Risk
Low risk documentation-only change; main risk is user confusion if the described CLI behavior/flags don’t match the released CLI version.

Overview
Docs now steer users away from mint openapi-check and toward mint validate for OpenAPI validation across the API playground guides.

The CLI installation docs clarify that mint validate also validates OpenAPI specs referenced via docs.json (api.openapi), add the --local-schema flag, and update --disable-openapi to note it disables both OpenAPI generation and spec validation. A deprecation warning was added to the openapi-check section pointing to mint validate.

Written by Cursor Bugbot for commit 4d745c6. This will update automatically on new commits. Configure here.

@mintlify
Copy link
Copy Markdown
Contributor Author

mintlify bot commented Apr 3, 2026

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

Project Status Preview Updated (UTC)
mintlify 🟢 Ready View Preview Apr 3, 2026, 12:47 AM

@ethanpalm
Copy link
Copy Markdown
Collaborator

#5150

@ethanpalm ethanpalm closed this Apr 5, 2026
@ethanpalm ethanpalm deleted the mintlify/deprecate-openapi-check-1775177051 branch April 5, 2026 02:03
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