Validate Openapi Spec

Use when checking if an OpenAPI spec is valid, looking for errors, or running `speakeasy lint`

majiayu000 Updated 567 repo stars

File contents

validate-openapi-spec

Use speakeasy lint to check for errors and warnings.

Command

speakeasy lint openapi -s <path-to-spec>

Output Categories

Severity Meaning Action
Error Blocks SDK generation Must fix
Warning May cause issues Should fix
Hint Best practice suggestion Consider fixing

Common Validation Issues

Issue Solution
Missing operationId Add operationId or use speakeasy suggest operation-ids
Invalid $ref Fix the reference path
Missing response schema Add response schema definitions
Duplicate operationId Make operation IDs unique

AI-Friendly Output

For commands with large outputs, pipe to grep or tail to reduce context:

speakeasy lint openapi -s ./openapi.yaml 2>&1 | grep -E "(error|warning)"

majiayu000/claude-skill-registry-data/tree/main/quality/validate-openapi-spec commit 0dd64d4deb

Frequently asked questions

npx skillmds@latest add majiayu000/validate-openapi-spec