You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/@v2/guides/lint-asyncapi.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,7 +32,7 @@ rules:
32
32
struct: error
33
33
```
34
34
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.
36
36
This rule checks that the document structure matches what is expected by the AsyncAPI specification.
37
37
38
38
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
46
46
## AsyncAPI rules
47
47
48
48
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 currentlysupported rules are:
50
50
51
51
- `info-contact`: the `Info` section must contain a valid `Contact` field.
52
52
- `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
71
71
## Configurable rule example
72
72
73
73
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:
75
75
76
76
```yaml
77
77
rules:
@@ -84,7 +84,7 @@ rules:
84
84
severity: warn
85
85
```
86
86
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!
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