Skip to content

Commit

Permalink
update readme.md
Browse files Browse the repository at this point in the history
  • Loading branch information
smoya authored Jun 14, 2024
1 parent 94a05a8 commit a7dfbee
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -234,11 +234,14 @@ Additionally to all the methods declared in the [Parser-API](https://github.com/
[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
- 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:

Expand Down

0 comments on commit a7dfbee

Please sign in to comment.