ephelan-spectral-ruleset

RHOAS OpenAPI Validator

A command-line tool and JavaScript API to let you validate your OpenAPI schema documents against the RHOAS API Guidelines.

Prerequisites

• Node >= 12.x
• NPM >= 5.x
• Yarn 1.x (for using Yarn workspaces)

Development

NOTE: This project uses Yarn workspaces for easier development.

Install dependencies:

yarn install

Build:

yarn build

Validate ./examples/openapi.yaml with the rhoas-openapi-validator CLI:

yarn rhoas-openapi-validator validate ./examples/openapi.yaml

Rules