Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
JLekawa authored and DmitryAnansky committed Dec 9, 2024
1 parent 0ab5628 commit ed6bcfa
Show file tree
Hide file tree
Showing 4 changed files with 5 additions and 4 deletions.
3 changes: 2 additions & 1 deletion .changeset/strong-ties-argue.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
"@redocly/cli": minor
---

Introduced the `struct` rule and deprecated the `spec` rule. Added the `spec` ruleset, which enforces compliance with the specifications.
Introduced the `struct` rule and deprecated the `spec` rule.
Added the `spec` ruleset, which enforces compliance with the specifications.
2 changes: 1 addition & 1 deletion docs/rules/arazzo/struct.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Ensures that your API document conforms to the [OpenAPI specification](https://s

The default setting for this rule (in the `recommended` and `minimal` configuration) is `error`.

This is an essential rule that should not be turned off except in rare and special cases.
This is an essential rule. Do not turned it off, except in rare and special cases.

## Configuration

Expand Down
2 changes: 1 addition & 1 deletion docs/rules/async/channels-kebab-case.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ channels:
The syntax for how the channels are described changed with the AsyncAPI 3.0 release.
If you still AsyncAPI 2.6, this rule works, and checks the channel address used as the key of the `channels` object.
This rule also works with AsyncAPI 2.6 and checks the channel address used as the key of the `channels` object.
For example, the rule would catch this example where `transactions/ticketSales` is used as a channel name:

```yaml
Expand Down
2 changes: 1 addition & 1 deletion docs/rules/async/no-channel-trailing-slash.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ channels:
The syntax for how the channels are described changed with the AsyncAPI 3.0 release.
This rule also works with AsyncAPI 2.6, and checks the channel address used as the key of the `channels` object.
This rule also works with AsyncAPI 2.6 and checks the channel address used as the key of the `channels` object.
For example, the rule produces an error when it sees this channel with a trailing slash:

```yaml
Expand Down

0 comments on commit ed6bcfa

Please sign in to comment.