AEP Validator CLI

A CLI tool to validate OpenAPI specifications for AEP (API Enhancement Proposals) compatibility.

Installation

# Global install
npm install -g aep-validator

# Or use directly with npx (no install needed)
npx aep-validator openapi.yaml

Usage

# Basic validation
aep-validator openapi.yaml

# Pretty printed output
aep-validator openapi.yaml --pretty

# Show library debug logs
aep-validator openapi.yaml --verbose

# Using npx (without installing)
npx aep-validator openapi.yaml --pretty

Output

Success

{
  "success": true,
  "resources": ["rule-node", "request-case", "service"]
}

Error

{
  "success": false,
  "errors": [
    {
      "rule": "no-pattern",
      "message": "No pattern found for resource rule-node",
      "path": "components.schemas.rule-node.x-aep-resource.patterns"
    }
  ]
}

Exit Codes

• 0 - Validation passed
• 1 - Validation failed or error occurred