openapi-validate

Validate and auto-fix OpenAPI 3.0/3.1 specifications in YAML or JSON.

Updated Nov 17, 2025
One-click install
npx skills add https://github.com/Valynt/ValueOS --skill openapi-validate
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: openapi-validate
Source: https://github.com/Valynt/ValueOS/tree/main/.windsurf/skills/openapi-validate
Command: npx skills add https://github.com/Valynt/ValueOS --skill openapi-validate

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires @apidevtools/swagger-parser, js-yaml, and includes scripts (resource) and references (resource) components.

What problem does it solve?

Validates OpenAPI specifications and automatically fixes structural and semantic issues to ensure compliant API definitions and reliable deployment artifacts.

Core Features & Use Cases

  • Validation: Lints and validates OpenAPI 3.0/3.1 specs across JSON and YAML formats using Spectral and OpenAPI tooling.
  • Auto-fix: Auto-fixes common issues such as missing operationId, missing descriptions, and broken references to improve robustness.
  • CI/CD & Documentation: Integrates into CI pipelines, bundles documentation, and generates client types from validated specs.

Quick Start

Run the validator on openapi.yaml to verify structure and apply fixes.

Frequently Asked Questions about openapi-validate

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I validate OpenAPI 3.0 and 3.1 specs in YAML or JSON?

You can validate OpenAPI 3.0 and 3.1 specs in YAML or JSON by running automated linters and custom Node scripts to check structure, schema descriptions, operation IDs, and security definitions for compliance.

How do I automatically fix missing operationId and broken references in OpenAPI specifications?

Automatically fix missing operationId, missing descriptions, and broken references in OpenAPI specifications by applying auto-fix rules that correct structural and semantic issues to ensure reliable deployment artifacts.

Can I use Spectral to lint OpenAPI specs for CI/CD pipeline validation?

Yes, you can use Spectral to lint OpenAPI specs for CI/CD pipeline validation. It integrates into CI workflows to enforce schema descriptions, operation IDs, and security definitions before bundling documentation and generating client types.

Does Swagger Parser support bundling documentation and validating OpenAPI 3.1 definitions?

Swagger Parser supports validating and bundling OpenAPI 3.0 and 3.1 definitions. It resolves structural dependencies in JSON and YAML formats to ensure compliant API definitions for documentation generation workflows.

What is the best way to ensure OpenAPI schema compliance before deployment?

The best way to ensure OpenAPI schema compliance before deployment is to validate and auto-fix structural and semantic issues using Spectral rules and OpenAPI tooling to enforce security definitions and operation IDs.

Why does my OpenAPI validation fail on missing descriptions and security definitions?

OpenAPI validation fails on missing descriptions and security definitions when specs lack required semantic metadata. Automated validation tools flag these issues, and auto-fix capabilities can generate the missing fields to restore compliance.