diff --git a/.changeset/strong-ties-argue.md b/.changeset/strong-ties-argue.md index 47cc977fb6..64e353a259 100644 --- a/.changeset/strong-ties-argue.md +++ b/.changeset/strong-ties-argue.md @@ -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. diff --git a/docs/rules/arazzo/struct.md b/docs/rules/arazzo/struct.md index 7f07c1493c..9ce2fa2a85 100644 --- a/docs/rules/arazzo/struct.md +++ b/docs/rules/arazzo/struct.md @@ -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 diff --git a/docs/rules/async/channels-kebab-case.md b/docs/rules/async/channels-kebab-case.md index 84be0f4b13..f2e4ba50e1 100644 --- a/docs/rules/async/channels-kebab-case.md +++ b/docs/rules/async/channels-kebab-case.md @@ -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 diff --git a/docs/rules/async/no-channel-trailing-slash.md b/docs/rules/async/no-channel-trailing-slash.md index 49804e5a53..60a0e92b65 100644 --- a/docs/rules/async/no-channel-trailing-slash.md +++ b/docs/rules/async/no-channel-trailing-slash.md @@ -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