Agent skill

openapi-validator

Validate OpenAPI specifications for correctness, security, and best practices

Stars 514
Forks 31

Install this agent skill to your Project

npx add-skill https://github.com/a5c-ai/babysitter/tree/main/library/specializations/software-architecture/skills/openapi-validator

SKILL.md

OpenAPI Validator Skill

Overview

Validates OpenAPI specifications for correctness, security definitions, best practices compliance, and breaking change detection between versions.

Capabilities

  • Validate OpenAPI 3.0/3.1 specifications
  • Check security definitions completeness
  • Lint for API design best practices
  • Compare specification versions
  • Detect breaking changes between versions
  • Custom rule configuration
  • Integration with Spectral and other linters

Target Processes

  • api-design-specification
  • system-design-review

Input Schema

json
{
  "type": "object",
  "required": ["specPath"],
  "properties": {
    "specPath": {
      "type": "string",
      "description": "Path to OpenAPI specification file"
    },
    "mode": {
      "type": "string",
      "enum": ["validate", "lint", "compare", "security"],
      "default": "validate"
    },
    "compareWith": {
      "type": "string",
      "description": "Path to previous spec version for comparison"
    },
    "rules": {
      "type": "object",
      "properties": {
        "ruleset": {
          "type": "string",
          "enum": ["spectral:oas", "custom"],
          "default": "spectral:oas"
        },
        "severity": {
          "type": "string",
          "enum": ["error", "warn", "info"],
          "default": "warn"
        }
      }
    }
  }
}

Output Schema

json
{
  "type": "object",
  "properties": {
    "valid": {
      "type": "boolean"
    },
    "errors": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": { "type": "string" },
          "message": { "type": "string" },
          "severity": { "type": "string" }
        }
      }
    },
    "warnings": {
      "type": "array"
    },
    "breakingChanges": {
      "type": "array",
      "description": "List of breaking changes when comparing"
    },
    "securityIssues": {
      "type": "array"
    }
  }
}

Usage Example

javascript
{
  kind: 'skill',
  skill: {
    name: 'openapi-validator',
    context: {
      specPath: 'api/openapi.yaml',
      mode: 'lint',
      rules: {
        ruleset: 'spectral:oas',
        severity: 'warn'
      }
    }
  }
}

Expand your agent's capabilities with these related and highly-rated skills.

a5c-ai/babysitter

gsd-tools

Central utility skill for GSD operations. Provides config parsing, slug generation, timestamps, path operations, and orchestrates calls to other specialized skills. Acts as the unified entry point that the original gsd-tools.cjs provided via its lib/ modules (commands, config, core, init).

514 31
Explore
a5c-ai/babysitter

model-profile-resolution

Resolve model profile (quality/balanced/budget) at orchestration start and map agents to specific models. Enables cost/quality tradeoffs by selecting appropriate AI models for each agent role.

514 31
Explore
a5c-ai/babysitter

verification-suite

Plan structure validation, phase completeness checks, reference integrity verification, and artifact existence confirmation. Provides the structured verification layer ensuring GSD artifacts are well-formed and complete.

514 31
Explore
a5c-ai/babysitter

state-management

STATE.md reading, writing, and field-level updates. Provides cross-session state persistence via .planning/STATE.md with structured fields for current task, completed phases, blockers, decisions, and quick tasks.

514 31
Explore
a5c-ai/babysitter

git-integration

Git commit patterns, formats, and conventions for GSD methodology. Provides atomic commits per task, structured commit messages, planning file commits, branch management, and milestone tag operations.

514 31
Explore
a5c-ai/babysitter

frontmatter-parsing

YAML frontmatter parsing and manipulation for .planning/ documents. Provides read, write, update, query, and validation operations on frontmatter blocks in GSD markdown artifacts.

514 31
Explore

Didn't find tool you were looking for?

Be as detailed as possible for better results