From bb556ed21afc61ba4df70b38ac161ded9aa2c687 Mon Sep 17 00:00:00 2001 From: Andrew Tatomyr Date: Thu, 19 Dec 2024 20:19:52 +0200 Subject: [PATCH] add docs --- docs/configuration/reference/rules.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/configuration/reference/rules.md b/docs/configuration/reference/rules.md index ca024fe411..ab1151e474 100644 --- a/docs/configuration/reference/rules.md +++ b/docs/configuration/reference/rules.md @@ -38,6 +38,14 @@ The `rules` block can be used at the root of a configuration file, or inside an --- +- message +- string +- Optional custom message for this rule. + Example: `My Error Derscription. {{message}}`. + The {{message}} placeholder (if provided) will be replaced with the actual message of the rule. + +--- + - {additional properties} - any - Some rules allow additional configuration, check the details of each rule to find out the values that can be supplied here. For example the [`boolean-parameter-prefixes` rule](../../rules/oas/boolean-parameter-prefixes.md) supports an additional option of `prefixes` that accepts an array of strings.