Skip to content

Commit 9be4c9c

Browse files
chore: update docs for v1 and v2 with correct arazzo rules syntax (#2477)
1 parent 19913e7 commit 9be4c9c

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

docs/@v1/guides/lint-arazzo.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,14 @@ run `redocly lint --generate-ignore-file` to add all problems to the ignore file
7373
Choose from the ready-made rulesets (`minimal`, `recommended` or `recommended-strict`), or go one better and configure the rules that suit your use case.
7474
There's a full [list of built-in rules for Arazzo](../rules/built-in-rules.md#arazzo-rules) to refer to.
7575

76-
Add the rules to `redocly.yaml`, but for Arazzo specifications, the rules go in their own configuration section called `arazzoRules`.
76+
Add the rules to `redocly.yaml`, but for Arazzo specifications, the rules go in their own configuration section called `arazzo1Rules`.
7777
The following example shows configuration for the minimal ruleset with some additional rules configuration:
7878

7979
```yaml
8080
extends:
8181
- minimal
8282

83-
arazzoRules:
83+
arazzo1Rules:
8484
sourceDescription-name-unique: warn
8585
respect-supported-versions: error
8686
```

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,14 @@ run `redocly lint --generate-ignore-file` to add all problems to the ignore file
7373
Choose from the ready-made rulesets (`spec`, `minimal`, `recommended` or `recommended-strict`), or go one better and configure the rules that suit your use case.
7474
There's a full [list of built-in rules for Arazzo](../rules/built-in-rules.md#arazzo-rules) to refer to.
7575

76-
Add the rules to `redocly.yaml`, but for Arazzo specifications, the rules go in their own configuration section called `arazzoRules`.
76+
Add the rules to `redocly.yaml`, but for Arazzo specifications, the rules go in their own configuration section called `arazzo1Rules`.
7777
The following example shows configuration for the minimal ruleset with some additional rules configuration:
7878

7979
```yaml
8080
extends:
8181
- minimal
8282

83-
arazzoRules:
83+
arazzo1Rules:
8484
sourceDescription-name-unique: warn
8585
respect-supported-versions: error
8686
```

docs/@v2/rules/respect/no-x-security-scheme-name-without-openapi.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ You must use an OpenAPI operation in a step to be able to reference `schemeName`
2424
An example configuration:
2525

2626
```yaml
27-
arazzoRules:
27+
arazzo1Rules:
2828
no-x-security-scheme-name-without-openapi: error
2929
```
3030
@@ -33,7 +33,7 @@ arazzoRules:
3333
Given the following configuration:
3434
3535
```yaml
36-
arazzoRules:
36+
arazzo1Rules:
3737
no-x-security-scheme-name-without-openapi: error
3838
```
3939

docs/@v2/rules/respect/x-security-scheme-required-values.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Different OpenAPI `securitySchemes` have some required values, like `token` or `
2424
An example configuration:
2525

2626
```yaml
27-
arazzoRules:
27+
arazzo1Rules:
2828
x-security-schema-required-values: error
2929
```
3030
@@ -33,7 +33,7 @@ arazzoRules:
3333
Given the following configuration:
3434
3535
```yaml
36-
arazzoRules:
36+
arazzo1Rules:
3737
x-security-schema-required-values: error
3838
```
3939

0 commit comments

Comments
 (0)