Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/whitlockjc/oval

oval: CLI for (O)penAPI Specification document (val)idation.
https://github.com/whitlockjc/oval

cli javascript nodejs openapi swagger

Last synced: 8 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/whitlockjc/oval
Owner: whitlockjc
License: mit
Created: 2018-07-18T18:51:02.000Z (over 6 years ago)
Default Branch: master
Last Pushed: 2024-05-14T14:21:38.000Z (6 months ago)
Last Synced: 2024-10-31T10:51:29.417Z (15 days ago)
Topics: cli, javascript, nodejs, openapi, swagger
Language: JavaScript
Homepage:
Size: 60.5 KB
Stars: 15
Watchers: 2
Forks: 2
Open Issues: 8
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE

Awesome Lists containing this project

README

        oval

====

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

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)

[![Version](https://img.shields.io/npm/v/oval.svg)](https://npmjs.org/package/oval)

[![TravisCI](https://travis-ci.org/whitlockjc/oval.svg?branch=master)](https://travis-ci.org/whitlockjc/oval)

[![Codecov](https://codecov.io/gh/whitlockjc/oval/branch/master/graph/badge.svg)](https://codecov.io/gh/whitlockjc/oval)

[![Downloads/week](https://img.shields.io/npm/dw/oval.svg)](https://npmjs.org/package/oval)

[![License](https://img.shields.io/npm/l/oval.svg)](https://github.com/whitlockjc/oval/blob/master/package.json)

# Overview

`oval` is an OpenAPI Specification _(OAS)_ document validator that was built to replace the CLI provided by

[swagger-tools](https://github.com/apigee-127/swagger-tools).  `oval` is built on top of

[sway](https://github.com/apigee-127/sway), the successor to the API portion of `swagger-tools`, which provides

extremely thorough OAS validation.  Plans for `oval` are to provide an [eslint](https://eslint.org/)-like experience for

OAS validation in the future.

Currently Oval supports OpenAPI v2.

* [Usage](#usage)

* [Commands](#commands)

# Usage

```sh-session

$ 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]`](#oval-help-command)

* [`oval validate LOCATION`](#oval-validate-location)

## `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](https://github.com/oclif/plugin-help/blob/v2.0.5/src/commands/help.ts)_

## `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](https://github.com/whitlockjc/oval/blob/v1.0.0/lib/commands/validate.js)_