Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add docs about built-in rulesets #6

Closed
wants to merge 1 commit into from
Closed

docs: add docs about built-in rulesets #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,16 @@ Additionally to all the methods declared in the [Parser-API](https://github.com/

## Spectral rulesets

[Spectral](https://github.com/stoplightio/spectral) powers the validation of AsyncAPI documents within ParserJS. For this reason, it is possible to use your rulesets/rules or overwrite existing ones, passing the `ruleset` option to the Parser instance:
[Spectral](https://github.com/stoplightio/spectral) powers the validation of AsyncAPI documents within ParserJS.
The default [built-in rulesets](src/ruleset) are:

- Core ruleset. Basic and global validation. Apply to all AsyncAPI Spec versions (with some exceptions).
- Recommended ruleset. These are good practices. They won't create validation errors but warnings.
- Specific rulesets per each AsyncAPI Spec version. Contain particular rulesets that apply only to documents of a particular Spec version.
- Core rulesets: Rules that generate validation errors if not fulfilled by a particular Spec version.
- Recommended rulesets: Best practices for a particular Spec version

It is possible to use your rulesets/rules or overwrite existing ones, passing the `ruleset` option to the Parser instance:

```ts
import { Parser, stringify, unstringify } from '@asyncapi/parser';
Expand Down
Loading