From a7dfbeed4de108026b8a6cbb296255bd878212a3 Mon Sep 17 00:00:00 2001 From: Sergio Moya <1083296+smoya@users.noreply.github.com> Date: Fri, 14 Jun 2024 12:04:38 +0200 Subject: [PATCH] update readme.md --- README.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 3e0631d5b..77b9b5a53 100644 --- a/README.md +++ b/README.md @@ -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: