https://github.com/jmlue42/spectral-jsonapi-ruleset
A Stoplight/Spectral linting ruleset for the JSON:API specification.
https://github.com/jmlue42/spectral-jsonapi-ruleset
api jsonapi linting linting-rules rulesets spectral stoplight style-guide styleguide
Last synced: about 1 month ago
JSON representation
A Stoplight/Spectral linting ruleset for the JSON:API specification.
- Host: GitHub
- URL: https://github.com/jmlue42/spectral-jsonapi-ruleset
- Owner: jmlue42
- License: mit
- Created: 2020-10-19T19:31:37.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-01-29T22:30:01.000Z (about 2 years ago)
- Last Synced: 2024-01-30T00:44:14.411Z (about 2 years ago)
- Topics: api, jsonapi, linting, linting-rules, rulesets, spectral, stoplight, style-guide, styleguide
- Language: Shell
- Homepage:
- Size: 315 KB
- Stars: 12
- Watchers: 7
- Forks: 7
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# spectral-jsonapi-ruleset
> A [Stoplight/Spectral](https://github.com/stoplightio/spectral) linting ruleset for the [JSON:API specification v1.0](https://jsonapi.org/format/1.0).
## Installation
For ways to integrate this ruleset into your Spectral linting suite. See [Sharing & Distributing Rulesets](https://meta.stoplight.io/docs/spectral/docs/guides/7-sharing-rulesets.md) at
## Organization
`.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
## Contributing
In lieu of a formal style guide (I know... ironic :grin:):
- Take care to maintain the existing coding format.
- Make needed adjustments to valid example
- Verify all linting PASS: `npm test`
## License
[MIT License](https://github.com/jmlue42/spectral-jsonapi-ruleset/blob/main/LICENSE)