spectral

spectral documentation

Version in MegaLinter: 5.6.0
Visit Official Web Site
See How to configure spectral rules
- If custom .openapirc.yml config file is not found, .openapirc.yml will be used
See Index of problems detected by spectral

Configuration in MegaLinter

Enable spectral by adding OPENAPI_SPECTRAL in ENABLE_LINTERS variable
Disable spectral by adding OPENAPI_SPECTRAL in DISABLE_LINTERS variable

Variable	Description	Default value
OPENAPI_SPECTRAL_ARGUMENTS	User custom arguments to add in linter CLI call Ex: `-s --foo "bar"`
OPENAPI_SPECTRAL_FILTER_REGEX_INCLUDE	Custom regex including filter Ex: `(src\\|lib)`	Include every file
OPENAPI_SPECTRAL_FILTER_REGEX_EXCLUDE	Custom regex excluding filter Ex: `(test\\|examples)`	Exclude no file
OPENAPI_SPECTRAL_CLI_LINT_MODE	Override default CLI lint mode - `file`: Calls the linter for each file - `list_of_files`: Call the linter with the list of files as argument - `project`: Call the linter from the root of the project	`file`
OPENAPI_SPECTRAL_FILE_EXTENSIONS	Allowed file extensions. `"*"` matches any extension, `""` matches empty extension. Empty list excludes all files Ex: `[".py", ""]`	`[".yml", ".yaml", ".json"]`
OPENAPI_SPECTRAL_FILE_NAMES_REGEX	File name regex filters. Regular expression list for filtering files by their base names using regex full match. Empty list includes all files Ex: `["Dockerfile(-.+)?", "Jenkinsfile"]`	Include every file
OPENAPI_SPECTRAL_PRE_COMMANDS	List of bash commands to run before the linter	None
OPENAPI_SPECTRAL_POST_COMMANDS	List of bash commands to run after the linter	None
OPENAPI_SPECTRAL_CONFIG_FILE	spectral configuration file name Use `LINTER_DEFAULT` to let the linter find it	`.openapirc.yml`
OPENAPI_SPECTRAL_RULES_PATH	Path where to find linter configuration file	Workspace folder, then MegaLinter default rules
OPENAPI_SPECTRAL_DISABLE_ERRORS	Run linter but consider errors as warnings	`false`
OPENAPI_SPECTRAL_DISABLE_ERRORS_IF_LESS_THAN	Maximum number of errors allowed	`0`

IDE Integration

Use spectral in your favorite IDE to catch errors before MegaLinter !

	IDE	Extension Name	Install
	stoplight	Native integration	Visit Web Site
	Visual Studio Code	vscode-spectral	Visit Web Site

MegaLinter Flavours

This linter is available in the following flavours

Flavor	Description	Embedded linters
all	Default MegaLinter Flavor	97
dart	Optimized for DART based projects	42
documentation	MegaLinter for documentation projects	41
dotnet	Optimized for C, C++, C# or VB based projects	49
go	Optimized for GO based projects	43
java	Optimized for JAVA based projects	43
javascript	Optimized for JAVASCRIPT or TYPESCRIPT based projects	50
php	Optimized for PHP based projects	46
python	Optimized for PYTHON based projects	49
ruby	Optimized for RUBY based projects	42
rust	Optimized for RUST based projects	42
salesforce	Optimized for Salesforce based projects	44
scala	Optimized for SCALA based projects	42
swift	Optimized for SWIFT based projects	42
terraform	Optimized for TERRAFORM based projects	47

Behind the scenes

How are identified applicable files

File extensions: .yml, .yaml, .json
Detected file content (regex): "openapi":, "swagger":, openapi:, swagger:

How the linting is performed

spectral is called one time by identified file

Example calls

spectral lint myfile.yml

spectral lint -r .openapirc.yml myfile.yml

Help content

spectral lint [documents..]

lint JSON/YAML documents from files or URLs

Positionals:
  documents  Location of JSON/YAML documents. Can be either a file, a glob or fetchable resource(s) on the web.  [array] [default: []]

Options:
  --version                    Show version number  [boolean]
  --help                       Show help  [boolean]
  --encoding, -e               text encoding to use  [string] [default: "utf8"]
  --format, -f                 formatter to use for outputting results  [string] [default: "stylish"]
  --output, -o                 output to a file instead of stdout  [string]
  --resolver                   path to custom json-ref-resolver instance  [string]
  --ruleset, -r                path/URL to a ruleset file  [string]
  --skip-rule, -s              ignore certain rules if they are causing trouble  [string]
  --fail-severity, -F          results of this level or above will trigger a failure exit code  [string] [choices: "error", "warn", "info", "hint"] [default: "error"]
  --display-only-failures, -D  only output results equal to or greater than --fail-severity  [boolean] [default: false]
  --ignore-unknown-format      do not warn about unmatched formats  [boolean] [default: false]
  --show-unmatched-globs       show unmatched glob patterns  [boolean] [default: false]
  --verbose, -v                increase verbosity  [boolean]
  --quiet, -q                  no logging - output only  [boolean]

Installation on mega-linter Docker image

NPM packages (node.js):
- @stoplight/spectral@5.6.0

Example success log

Results of spectral linter (version 5.6.0)
See documentation on https://megalinter.github.io/descriptors/openapi_spectral/
-----------------------------------------------

[SUCCESS] .automation/test/openapi/openapi_good_1.yml
    OpenAPI 3.x detected
    No results with a severity of 'error' or higher found!

[SUCCESS] .automation/test/openapi/openapi_good_2.json
    OpenAPI 3.x detected
    No results with a severity of 'error' or higher found!

Example error log

Results of spectral linter (version 5.6.0)
See documentation on https://megalinter.github.io/descriptors/openapi_spectral/
-----------------------------------------------

[ERROR] .automation/test/openapi/openapi_bad_1.yml
    OpenAPI 3.x detected

    .automation/test/openapi/openapi_bad_1.yml
     1:1  warning  info-contact      Info object should contain `contact` object.
     1:1  warning  info-description  OpenAPI object info `description` must be present and non-empty string.
     1:1  warning  oas3-api-servers  OpenAPI `servers` must be present and non-empty array.
     1:1    error  oas3-schema       Object should have required property `info`.
     1:1  warning  openapi-tags      OpenAPI object should have non-empty `tags` array.

    ✖ 5 problems (1 error, 4 warnings, 0 infos, 0 hints)

[ERROR] .automation/test/openapi/openapi_bad_2.json
    OpenAPI 3.x detected

    .automation/test/openapi/openapi_bad_2.json
     1:1  warning  info-contact      Info object should contain `contact` object.
     1:1  warning  info-description  OpenAPI object info `description` must be present and non-empty string.
     1:1  warning  oas3-api-servers  OpenAPI `servers` must be present and non-empty array.
     1:1    error  oas3-schema       Object should have required property `info`.
     1:1  warning  openapi-tags      OpenAPI object should have non-empty `tags` array.

    ✖ 5 problems (1 error, 4 warnings, 0 infos, 0 hints)