Skip to content

Conversation

@mintlify
Copy link
Contributor

@mintlify mintlify bot commented Jan 5, 2026

Added comprehensive troubleshooting documentation for OpenAPI validation errors including common error types, fixes, and a step-by-step workflow. This helps users understand and resolve validation errors when running mint openapi-check or mint dev.

Files changed

  • api-playground/troubleshooting.mdx - Added new "OpenAPI validation errors" section with detailed examples and troubleshooting steps

Note

Adds comprehensive guidance to api-playground/troubleshooting.mdx for diagnosing and fixing OpenAPI validation issues.

  • Explains error path format in validation messages and how to locate issues
  • Details response schema errors (missing $ref/content/description) with incorrect vs. correct JSON examples
  • Covers common $ref problems (nonexistent components, unsupported external refs) and corrections
  • Provides a concise troubleshooting workflow: identify location, check spec, validate in Swagger Editor, apply fixes, re-run checks
  • Adds links to relevant OpenAPI spec sections and tools

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

Co-Authored-By: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
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.

2 participants