Back to Skills

validate-openapi-spec

verified

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

View on GitHub

Marketplace

speakeasy

speakeasy-api/speakeasy

Plugin

speakeasy

productivity

Repository

speakeasy-api/speakeasy
378stars

skills/validate-openapi-spec/SKILL.md

Last Verified

January 17, 2026

Install Skill

Select agents to install to:

Scope:
npx add-skill https://github.com/speakeasy-api/speakeasy/blob/main/skills/validate-openapi-spec/SKILL.md -a claude-code --skill validate-openapi-spec

Installation paths:

Claude
.claude/skills/validate-openapi-spec/
Powered by add-skill CLI

Instructions

# validate-openapi-spec

Use `speakeasy lint` to check for errors and warnings.

## Command

```bash
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:
```bash
speakeasy lint openapi -s ./openapi.yaml 2>&1 | grep -E "(error|warning)"
```

Validation Details

Front Matter
Required Fields
Valid Name Format
Valid Description
Has Sections
Allowed Tools
Instruction Length:
866 chars