Deprecate openapi-check in favor of validate#5109
Closed
mintlify[bot] wants to merge 1 commit intomainfrom
Closed
Conversation
Generated-By: mintlify-agent
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Collaborator
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.
Summary
The
openapi-checkCLI command is now deprecated. Thevalidatecommand now automatically validates OpenAPI specifications referenced indocs.json.openapi-checkas deprecated with a warning pointing users tomint validatevalidatecommand docs to describe automatic OpenAPI spec validation and the new--local-schemaflagmint openapi-checkacross API playground docs to usemint validateinsteadNote
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-checkand towardmint validatefor OpenAPI validation across the API playground guides.The CLI installation docs clarify that
mint validatealso validates OpenAPI specs referenced viadocs.json(api.openapi), add the--local-schemaflag, and update--disable-openapito note it disables both OpenAPI generation and spec validation. A deprecation warning was added to theopenapi-checksection pointing tomint validate.Written by Cursor Bugbot for commit 4d745c6. This will update automatically on new commits. Configure here.