@sumup/sumup-api-style-guide v1.0.0

SumUp REST API Style Guide

How to use the Spectral Ruleset

Dependencies

The Spectral Ruleset requires Node version 14 or later.

Install Spectral

npm i @stoplight/spectral-cli -g

Usage

You can specify the Ruleset directly on the command line:

spectral lint -r https://raw.githubusercontent.com/sumup/sumup-api-style-guide/main/spectral.yaml <api definition file>

Or you can create a Spectral configuration file (.spectral.yaml) that references the ruleset:

extends:
  - https://raw.githubusercontent.com/sumup/sumup-api-style-guide/main/spectral.yaml

Example

spectral lint -r https://raw.githubusercontent.com/sumup/sumup-api-style-guide/main/spectral.yaml petstore.yaml