Skip to content

Commit 370c60b

Browse files
committed
fix: fix docs issue
1 parent 286c82e commit 370c60b

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

docs/@v2/rules/configurable-rules.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,14 +20,14 @@ A configurable rule describes the contents that the linter expects to find in yo
2020

2121
## Configurable rule object
2222

23-
| Property | Type | Description |
24-
| ---------- | ------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25-
| subject | [Subject object](#subject-object) | **REQUIRED.** Locates the specific [OpenAPI node type](#subject-node-types-and-properties) or `any` (see [example](#any-example)) and possible properties and values that the [lint command](../commands/lint.md) evaluates. Use with `where` to narrow further. |
26-
| assertions | [Assertion object](#assertion-object) | **REQUIRED.** Flags a problem when a defined assertion evaluates false. There are a variety of built-in assertions included. You may also create plugins with custom functions and use them as assertions. |
27-
| where | [Where object](#where-object) | Narrows subjects by evaluating the where list first in the order defined (from top to bottom). The resolution of reference objects is done at the `where` level. See [where example](#where-example). The `where` evaluation itself does not result in any problems. |
28-
| message | string | Custom text displayed when an assertion fails. Placeholders can be used to include contextual information such as the rule name, object type, property, error location, and problems. See [Using message placeholders](#using-message-placeholders) and [List of available placeholders](#list-of-available-placeholders) for details. |
29-
| suggest | [string] | List of suggestions to display if the problem occurs. |
30-
| severity | string | Configure the severity level of the problem if the assertion is false. It must be one of these values: `error`, `warn`, `off`. Default value is `error`. |
23+
| Property | Type | Description |
24+
| ---------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
25+
| subject | [Subject object](#subject-object) | **REQUIRED.** Locates the specific [OpenAPI node type](#subject-node-types-and-properties) or `any` (see [example](#any-example)) and possible properties and values that the [lint command](../commands/lint.md) evaluates. Use with `where` to narrow further. |
26+
| assertions | [Assertion object](#assertion-object) | **REQUIRED.** Flags a problem when a defined assertion evaluates false. There are a variety of built-in assertions included. You may also create plugins with custom functions and use them as assertions. |
27+
| where | [Where object](#where-object) | Narrows subjects by evaluating the where list first in the order defined (from top to bottom). The resolution of reference objects is done at the `where` level. See [where example](#where-example). The `where` evaluation itself does not result in any problems. |
28+
| message | string | Custom text displayed when an assertion fails. Placeholders can be used to include contextual information such as the rule name, object type, property, error location, and problems. See [Using message placeholders](#use-placeholders-in-messages) and [List of available placeholders](#list-of-available-placeholders) for details. |
29+
| suggest | [string] | List of suggestions to display if the problem occurs. |
30+
| severity | string | Configure the severity level of the problem if the assertion is false. It must be one of these values: `error`, `warn`, `off`. Default value is `error`. |
3131

3232
## Subject object
3333

@@ -670,7 +670,7 @@ rules:
670670
- description
671671
```
672672

673-
### Using message placeholders
673+
### Use placeholders in messages
674674

675675
Custom rule messages can include dynamic placeholders that are replaced with contextual information when a rule fails.
676676
This helps you provide clear, precise, and useful feedback about where and why a validation error occurred.
@@ -692,7 +692,7 @@ rules:
692692

693693
**Example output:**
694694

695-
```
695+
```text
696696
POST operation is missing a requestBody at #/paths/~1users/post
697697
```
698698

@@ -713,7 +713,7 @@ rules:
713713

714714
**Example output:**
715715

716-
```
716+
```text
717717
Rule rule/operation-validation failed: Operation at #/paths/~1users/post with key "post" — requestBody is required
718718
```
719719

0 commit comments

Comments
 (0)