Configurable and extensible validator/linter for OpenAPI documents
Branch: master
Clone or download
dpopp07 Merge pull request #26 from IBM/add-test-for-schema-type
test: add type/format test for top level schema and move oas3 test
Latest commit cb3545a Feb 20, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src refactor: only allow type file for root schemas Feb 18, 2019
test test: add type/format test for top level schema and move oas3 test to… Feb 19, 2019
.eslintrc.js Merge branch 'master' of https://github.ibm.com/MIL/swagger-editor-ibm Dec 20, 2017
.gitignore Merge branch 'master' of https://github.ibm.com/MIL/swagger-editor-ibm Dec 19, 2017
.npmignore update .npmignore Dec 1, 2017
.releaserc
.travis.yml
CHANGELOG.md chore(release): 0.2.3 [skip ci] Feb 19, 2019
CONTRIBUTING.md docs(contributing): add contributing guidelines and make repo commiti… Dec 5, 2018
LICENSE initial release with two updated custom validations checking empty de… Jun 25, 2017
README.md Add validation rule for description in top-level schema Feb 3, 2019
package-lock.json chore(release): 0.2.3 [skip ci] Feb 19, 2019
package.json chore(release): 0.2.3 [skip ci] Feb 19, 2019

README.md

Build Status npm-version semantic-release Commitizen friendly

OpenAPI Validator

This command line tool lets you validate OpenAPI documents according to their specification, either 2.0 or 3.0, as well as custom IBM-defined best practices.

Prerequisites

  • Node 8.9.x
  • NPM 5.x

Table of contents

Installation

Install with NPM (recommended)

npm install -g ibm-openapi-validator

The -g flag installs the tool globally so that the validator can be run from anywhere in the file system. Alternatively, you can pass no flag or the --save-dev flag to add the validator as a dependency to your project and run it from your NPM scripts.

Build from source

  1. Clone or download this repository
  2. Navigate to the root directory of this project.
  3. Install the dependencies using npm install
  4. Build the command line tool by running npm run build-and-link.

Usage

Command line

lint-openapi [options] [command] [<files>]

[options]

  • -s (--report_statistics) : Print a simple report at the end of the output showing the frequency, in percentage, of each error/warning.
  • -d (--default_mode) : This option turns off configuration and runs the validator in default mode.
  • -p (--print_validator_modules) : Print the name of the validator source file the error/warning was caught it. This can be helpful for developing validations.
  • -n (--no_colors) : The output is colored by default. If this bothers you, this flag will turn off the coloring.
  • -v (--version) : Print the current semantic version of the validator
  • -h (--help) : This option prints the usage menu.

These options only apply to running the validator on a file, not to any commands.

[command]

$ lint-openapi init

  • init : The init command initializes a .validaterc file, used to configure the validator. It can also be used to reset the configurable rules to their default values.

[command]

$ lint-openapi migrate

  • migrate : The migrate command migrates a .validaterc file from the legacy format to the current format, retaining all custom rules. The new format is required - this command provides an option to keep custom rules without manually updating the file or initializing a new configuration file with all rules set to the defaults using lint-openapi init.

None of the above options pertain to these commands.

<files>

  • The OpenAPI document(s) to be validated. All files must be a valid JSON or YAML (only .json, .yml, and .yaml file extensions are supported).
  • Multiple, space-separated files can be passed in and each will be validated. This includes support for globs (e.g. lint-openapi files/* will run the validator on all files in files/)

Node module

const validator = require('ibm-openapi-validator');

validator(openApiDoc)
  .then(validationResults => {
    console.log(JSON.stringify(validationResults, null, 2));
  });

// or, if inside `async` function
const validationResults = await validator(openApiDoc);
console.log(JSON.stringify(validationResults, null, 2));

API

validator(openApiDoc, [defaultMode = false])

Returns a Promise with the validation results.

openApiDoc

Type: Object
An object that represents an OpenAPI document.

defaultMode

Type: boolean
Default: false
If set to true, the validator will ignore the .validaterc file and will use the configuration defaults.

Validation results

The Promise returned from the validator resolves into a JSON object. The structure of the object is:

{
  errors:
  [
    {
      path: 'path.to.error.in.object'
      message: 'Major problem in the OpenAPI document.'
    }
  ],
  warnings:
  [
    {
      path: 'path.to.warning.in.object'
      message: 'Minor problem in the OpenAPI document.'
    }
  ]
}

The object will always have errors and warnings keys that map to arrays. If an array is empty, that means there were no errors/warnings in the OpenAPI document.

Configuration

The command line validator is built so that each IBM validation can be configured. To get started configuring the validator, set up a configuration file and continue reading this section. Specfic validation "rules" can be turned off, or configured to trigger either errors or warnings in the validator. Some validations can be configured even further, such as switching the case convention to validate against for parameter names. Additionally, certain files files can be ignored by the validator. Any glob placed in a file called .validateignore will always be ignored by the validator at runtime. This is set up like a .gitignore or a .eslintignore file.

Setup

To set up the configuration capability, simply run the command lint-openapi init. This will create (or over-write) a .validaterc file with all rules set to their default value. This command does not create a .validateignore. That file must be created manually. These rules can then be changed to configure the validator. Continue reading for more details.

WARNING: If a .validaterc file already exists and has been customized, this command will reset all rules to their default values.

It is recommended to place these files in the root directory of your project. The code will recursively search up the filesystem for these files from wherever the validator is being run. Wherever in the file system the validator is being run, the nearest versions of these files will be used.

Definitions

Specs

The validator supports two API definition specifications - Swagger 2.0 and OpenAPI 3.0. The validator will automatically determine which spec a document is written in. There are some rules in the validator that only apply to one of the specs and some rules that apply to both. The configuration structure is organized by these "specs". The supported specs are described below:

Spec Description
swagger2 Rules pertaining only to the Swagger 2.0 specification.
oas3 Rules pertaining only to the OpenAPI 3.0 specification
shared Rules pertaining to both of the above specifications.

Categories

Rules are further organized by categories. Not every category is supported in every spec - these are a superset of the available categories. For the actual structure, see the default values. The supported categories are described below:

Category Description
operations Rules pertaining to Operation Objects
parameters Rules pertaining to Parameter Objects
paths Rules pertaining to Paths Objects
schemas Rules pertaining to Schema Objects
security_definitions Rules pertaining to Security Definition Objects
security Rules pertaining to Security Objects
walker Rules pertaining to the entire document.

Rules

Each category contains a group of rules. The spec that each rule applies to is marked in the third column. For the actual configuration structure, see the default values. The supported rules are described below:

operations
Rule Description Spec
no_consumes_for_put_or_post Flag put or post operations that do not have a consumes field. swagger2
get_op_has_consumes Flag get operations that contain a consumes field. swagger2
no_produces Flag operations that do not have a produces field (except for head and operations that return a 204). swagger2
no_operation_id Flag any operations that do not have an operationId field. shared
operation_id_case_convention Flag any operationId that does not follow a given case convention. shared
no_summary Flag any operations that do not have a summary field. shared
no_array_responses Flag any operations with a top-level array response. shared
parameter_order Flag any operations with optional parameters before a required param. shared
no_request_body_content Flag any operations with a requestBody that does not have a content field. oas3
parameters
Rule Description Spec
required_param_has_default Flag any required parameter that specifies a default value. shared
no_parameter_description Flag any parameter that does not contain a description field. shared
param_name_case_convention Flag any parameter with a name field that does not follow a given case convention. shared
invalid_type_format_pair Flag any parameter that does not follow the data type/format rules. shared
content_type_parameter Flag any parameter that explicitly defines a Content-Type. That should be defined by the consumes field. shared
accept_type_parameter Flag any parameter that explicitly defines an Accept type. That should be defined by the produces field. shared
authorization_parameter Flag any parameter that explicitly defines an Authorization type. That should be defined by the securityDefinitions/security fields. shared
no_in_property Flag any parameter that does not define an in property. oas3
invalid_in_property Flag any parameter that has an invalid in property. oas3
missing_schema_or_content Flag any parameter that does not define its data type with schema or content. oas3
has_schema_and_content Flag any parameter that defines data type with both schema and content. oas3
paths
Rule Description Spec
missing_path_parameter For a path that contains path parameters, flag any operations that do not correctly define those parameters. shared
snake_case_only Flag any path segment that does not use snake case. shared
responses
Rule Description Spec
inline_response_schema Flag any response object with a schema that doesn't reference a named model. shared
no_response_codes Flag any response object that has no valid response codes. oas3
no_success_response_codes Flag any response object that has no success response codes. oas3
schemas
Rule Description Spec
invalid_type_format_pair Flag any schema that does not follow the data type/format rules. shared
snake_case_only Flag any property with a name that is not lower snake case. shared
no_schema_description Flag any schema without a description field. shared
no_property_description Flag any schema that contains a 'property' without a description field. shared
description_mentions_json Flag any schema with a 'property' description that mentions the word 'JSON'. shared
array_of_arrays Flag any schema with a 'property' of type array with items of type array. shared
security_definitions
Rule Description Spec
unused_security_schemes Flag any security scheme defined in securityDefinitions that is not used in the spec. shared
unused_security_scopes Flag any security scope defined in securityDefinitions that is not used in the spec. shared
security
Rule Description Spec
invalid_non_empty_security_array Flag any non-empty security array this is not of type OAuth2 shared
walker
Rule Description Spec
no_empty_descriptions Flag any description field in the spec with an empty or whitespace string. shared
has_circular_references Flag any circular references found in the Swagger spec. shared
$ref_siblings Flag any properties that are siblings of a $ref property. shared

Statuses

Each rule can be assigned a status. The supported statuses are error, warning, and off. Some rules can be configured further with configuration options. The format of this configuration is to provide an array, rather than just a string. e.g. "param_name_case_convention": ["error", "lower_camel_case"] If just a string is provided for these rule, the default configuration option will be used. If only one value is provided in the array, it MUST be a status. The default configuration option will be used in this case as well. The rules that support configuration options will have two values in the defaults table.

Configuration Options

For rules that accept additional configuration, there will be a limited set of available options.

Case Convention Options
  • Some rules check strings for adherance to a specific case convention. In some cases, the case convention checked is configurable.
  • Rules with configurable case conventions will end in _case_convention, such as param_name_case_convention.
Option Description Example
lower_snake_case Words must follow standard lower snake case conventions. learning_opt_out
upper_camel_case Words must follow standard upper camel case conventions. LearningOptOut
lower_camel_case Words must follow standard lower camel case conventions. learningOptOut
lower_dash_case Words must follow standard lower dash case conventions. learning-opt-out

Configuration file

Configurations are defined in a file, titled .validaterc.

The configuration file must be structured as a JSON object with specs as first-level keys, categories as second-level keys, rules as third-level keys, and statuses as values for the 'rules' objects.

If a rule is not included in the file, that rule will be set to the default status automatically. See the Default Values for more info.

For an example of the structure, see the defaults file.

The easiest way to create a .validaterc file is using the initialization command.

Default mode

The validator has a set of predefined default statuses for each rule that are used in 'default mode'.

Default mode can be turned on with the command line option -d. If this option is given, the .validaterc file will be ignored.

If a .validaterc file does not exist at the root directory of your project, the validator will automatically run in default mode.

The default values for each rule are described below.

Default values

swagger2
operations
Rule Default
no_consumes_for_put_or_post error
get_op_has_consumes warning
no_produces error
oas3
operations
Rule Default
no_request_body_content error
parameters
Rule Default
no_in_property error
invalid_in_property error
missing_schema_or_content error
has_schema_and_content error
responses
Rule Default
no_response_codes error
no_success_response_codes warning
shared
operations
Rule Default
no_operation_id warning
operation_id_case_convention warning, lower_camel_case
no_summary warning
no_array_responses error
parameter_order warning
parameters
Rule Default
no_parameter_description error
param_name_case_convention warning, lower_snake_case
invalid_type_format_pair error
content_type_parameter error
accept_type_parameter error
authorization_parameter warning
required_param_has_default warning
paths
Rule Default
missing_path_parameter error
snake_case_only warning
responses
Rule Default
inline_response_schema warning
security_definitions
Rule Default
unused_security_schemes warning
unused_security_scopes warning
security
Rule Default
invalid_non_empty_security_array error
schemas
Rule Default
invalid_type_format_pair error
snake_case_only warning
no_schema_description warning
no_property_description warning
description_mentions_json warning
array_of_arrays warning
walker
Rule Default
no_empty_descriptions error
has_circular_references warning
$ref_siblings off

Turning off update-notifier

This package uses update-notifier to alert users when new versions of the tool are available. To turn this feature off, follow these instructions from the package authors. It is recommended to keep this feature on to help stay up to date with the latest changes.

License

Copyright 2017 SmartBear Software

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.