A Stoplight/Spectral linting ruleset for the JSON:API specification v1.0.
For ways to integrate this ruleset into your Spectral linting suite. See Sharing & Distributing Rulesets at https://meta.stoplight.io/
.spectral.yml - Spectral Ruleset
The ruleset extends - spectral:oas, spectral's built-in OAS linting rules.
The rules are generally organized by the JSON:API specification section the rule is mentioned in. Each rule notes the section url it realates to.
examples folder contains valid and invalid OAS3.1 examples
In lieu of a formal style guide (I know... ironic 😁):
- Take care to maintain the existing coding format.
- Make needed adjustments to valid example
- Verify all linting PASS:
npm test