Skip to content

Commit 22c67fd

Browse files
authored
Apply suggestions from code review
1 parent dfabefb commit 22c67fd

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

.changeset/brave-spoons-sparkle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22
"@redocly/openapi-core": major
33
---
44

5-
Removed backward compatibility for the `spec` rule. Users should now use `struct` instead.
5+
Removed backward compatibility for the `spec` rule. Use `struct` instead.

docs/@v2/guides/lint-asyncapi.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ rules:
3232
struct: error
3333
```
3434
35-
The empty `extends` element instructs Redocly CLI not to use any existing rulesets, but to emit an error if the `struct` rule finds any problem.
35+
The empty `extends` element instructs Redocly CLI not to use any existing rulesets, but to display an error if the `struct` rule finds any problem.
3636
This rule checks that the document structure matches what is expected by the AsyncAPI specification.
3737

3838
With this configuration file, and your AsyncAPI description file (or use one of the [existing examples](https://github.com/asyncapi/spec/tree/master/examples)), run the linting command:
@@ -46,7 +46,7 @@ The output describes any structural problems with the document, or reports that
4646
## AsyncAPI rules
4747

4848
To expand the linting checks for an AsyncAPI description, start by enabling some of the built-in rules.
49-
The currently-supported rules are:
49+
The currently supported rules are:
5050

5151
- `info-contact`: the `Info` section must contain a valid `Contact` field.
5252
- `operation-operationId`: every operation must have a valid `operationId`.
@@ -71,7 +71,7 @@ Pick and mix the available rules until you have the setup that fits your situati
7171
## Configurable rule example
7272

7373
Redocly CLI also offers [configurable rules](../rules/configurable-rules.md) that allow you to set assertions about the API description being linted, and this functionality works just as well for AsyncAPI as for OpenAPI.
74-
The following example shows a configurable rule that emits a warning if the `title` field is not present in the `info` block:
74+
The following example shows a configurable rule that displays a warning if the `title` field is not present in the `info` block:
7575

7676
```yaml
7777
rules:
@@ -84,7 +84,7 @@ rules:
8484
severity: warn
8585
```
8686

87-
With the extensive configurable rules options available, there are many opportunities to make sure that your AsyncAPI spec conforms with expectations (we'd also love to see what you're building, it helps us know how things are going!).
87+
With the extensive configurable rules options available, there are many opportunities to make sure that your AsyncAPI spec conforms with expectations. We'd also love to see what you're building - it helps us know how things are going!
8888

8989
{% admonition type="info" name="Custom plugins" %}
9090
For those users with advanced requirements and JavaScript skills, the [custom plugins](../custom-plugins/index.md) feature offers some extension points if you need them.

0 commit comments

Comments
 (0)