Skip to content

Commit bb556ed

Browse files
committed
add docs
1 parent 269a3bb commit bb556ed

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

docs/configuration/reference/rules.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,14 @@ The `rules` block can be used at the root of a configuration file, or inside an
3838

3939
---
4040

41+
- message
42+
- string
43+
- Optional custom message for this rule.
44+
Example: `My Error Derscription. {{message}}`.
45+
The {{message}} placeholder (if provided) will be replaced with the actual message of the rule.
46+
47+
---
48+
4149
- {additional properties}
4250
- any
4351
- 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.

0 commit comments

Comments
 (0)