oval: CLI for (O)penAPI Specification document (val)idation.
Switch branches/tags
Nothing to show
Clone or download
whitlockjc Merge pull request #4 from aeden/master
Document that current support is for OpenAPI v2
Latest commit 0202a1b Sep 26, 2018

README.md

oval

oval: CLI for (O)penAPI Specification document (val)idation

oclif Version

TravisCI Codecov Downloads/week License

Overview

oval is an OpenAPI Specification (OAS) document validator that was built to replace the CLI provided by swagger-tools. oval is built on top of sway, the successor to the API portion of swagger-tools, which provides extremely thorough OAS validation. Plans for oval are to provide an eslint-like experience for OAS validation in the future.

Currently Oval supports OpenAPI v2.

Usage

$ npm install -g oval
$ oval COMMAND
running command...
$ oval (-v|--version|version)
oval/1.0.0 darwin-x64 node-v8.3.0
$ oval --help [COMMAND]
USAGE
  $ oval COMMAND
...

Commands

oval help [COMMAND]

display help for oval

USAGE
  $ oval help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

oval validate LOCATION

validate an OpenAPI Specification (OAS) document

USAGE
  $ oval validate LOCATION

ARGUMENTS
  LOCATION  The path/URL to the OAS document being validated

OPTIONS
  -N, --no-color            turn off colored output
  -j, --json                output results as JSON
  -p, --print-success       print message for success
  -w, --warnings-as-errors  treat warnings as errors

See code: lib/commands/validate.js