Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@tatomyr
tatomyr committed Dec 19, 2024
1 parent 269a3bb commit bb556ed
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/configuration/reference/rules.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Check failure on line 45 in docs/configuration/reference/rules.md

View workflow job for this annotation

GitHub Actions / vale action 

[vale] reported by reviewdog 🐶
[Redocly-Docs.FutureTense] Avoid using future tense: "will be". Use present tense instead.

Raw Output:
{"message": "[Redocly-Docs.FutureTense] Avoid using future tense: \"will be\". Use present tense instead.", "location": {"path": "docs/configuration/reference/rules.md", "range": {"start": {"line": 45, "column": 45}}}, "severity": "ERROR"}

---

- {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.
Expand Down

0 comments on commit bb556ed

Please sign in to comment.