Skip to end of metadata
Go to start of metadata

Spectral

We have successfully applied Spectral along with custom rules to "lint" Swagger files based on the ONAP Swagger style guide!

Spectral may be found at:  https://github.com/stoplightio/spectral

Instructions to install Spectral may be found at: https://stoplight.io/p/docs/gh/stoplightio/spectral/docs/getting-started/installation.md

With Spectral, ONAP can provide our own ruleset file extending the rules used by Spectral.

The Draft ONAP Swagger Specific Style Rules for Spectral may be found here: ONAP Swagger Style Ruleset for Spectral

The Spectral CLI will look for a ruleset file called .spectral.yml or .spectral.json in the current working directory.

We could also use a different file by using the CLI option --ruleset 

Additional information on Spectral Rulesets may be found at: https://stoplight.io/p/docs/gh/stoplightio/spectral/docs/getting-started/rulesets.md


  • No labels