Skip to content

Commit 875b08c

Browse files
committed
docs: update sidebar and built-in rules documentation
1 parent ab62b03 commit 875b08c

File tree

8 files changed

+26
-22
lines changed

8 files changed

+26
-22
lines changed

docs/@v2/rules/built-in-rules.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -142,11 +142,11 @@ Within the Arazzo family of rules, there are rules for the main Arazzo specifica
142142
The below rules are being migrated to Respect:
143143

144144
- [no-criteria-xpath](./respect/no-criteria-xpath.md): the `xpath` type criteria is not supported by Respect.
145-
- [respect-supported-versions](./respect/respect-supported-versions.md): the `version` property must be one of the supported values.
145+
- [no-x-security-both-scheme-and-scheme-name](./respect/no-x-security-both-scheme-and-scheme-name.md): forbids using both `scheme` and `schemeName` in the same `x-security` item
146146
- [no-x-security-scheme-name-without-openapi](./respect/no-x-security-scheme-name-without-openapi.md): the `x-security` can't use `schemeName` when Step request is described with `x-operation`.
147-
- [x-security-scheme-required-values](./respect/x-security-scheme-required-values.md) validate that `x-security` have all required `values` described according to the used `scheme`.
147+
- [respect-supported-versions](./respect/respect-supported-versions.md): the `version` property must be one of the supported values.
148148
- [x-security-scheme-name-reference](./respect/x-security-scheme-name-reference.md): when multiple `sourceDescriptions` exist, `workflow.x-security.schemeName` must reference a source description (for example, `$sourceDescriptions.{name}.scheme`)
149-
- [no-x-security-both-scheme-and-scheme-name](./respect/no-x-security-both-scheme-and-scheme-name.md): forbids using both `scheme` and `schemeName` in the same `x-security` item
149+
- [x-security-scheme-required-values](./respect/x-security-scheme-required-values.md) validate that `x-security` have all required `values` described according to the used `scheme`.
150150

151151
## Resources
152152

docs/@v2/rules/respect/x-security-scheme-name-reference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# x-security-scheme-name-reference
22

3-
When multiple `sourceDescriptions` exist, `workflow.x-security.schemeName` must be a reference to a specific source description (for example, `$sourceDescriptions.{name}.scheme`). If there is only one source description, a plain string is allowed.
3+
When multiple `sourceDescriptions` exist, `workflow.x-security.schemeName` must be a reference to a specific source description (for example, `$sourceDescriptions.{name}.schemeName`). If there is only one source description, a plain string is allowed.
44

55
| Arazzo | Compatibility |
66
| ------ | ------------- |
77
| 1.x ||
88

99
## Design principles
1010

11-
With multiple source descriptions, using a plain `schemeName` is ambiguous. Requiring a reference of the form `$sourceDescriptions.{name}.scheme` disambiguates which source description provides the security scheme.
11+
With multiple source descriptions, using a plain `schemeName` is ambiguous. Requiring a reference of the form `$sourceDescriptions.{name}.schemeName` disambiguates which source description provides the security scheme.
1212

1313
## Configuration
1414

docs/@v2/sidebars.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -149,10 +149,10 @@
149149
- separator: Arazzo
150150
- page: rules/respect/no-criteria-xpath.md
151151
- page: rules/respect/respect-supported-versions.md
152+
- page: rules/respect/no-x-security-both-scheme-and-scheme-name.md
152153
- page: rules/respect/no-x-security-scheme-name-without-openapi.md
153-
- page: rules/respect/x-security-scheme-required-values.md
154154
- page: rules/respect/x-security-scheme-name-reference.md
155-
- page: rules/respect/no-x-security-both-scheme-and-scheme-name.md
155+
- page: rules/respect/x-security-scheme-required-values.md
156156
- page: rules/arazzo/criteria-unique.md
157157
- page: rules/arazzo/parameters-unique.md
158158
- page: rules/arazzo/requestBody-replacements-unique.md

packages/core/src/config/all.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -276,24 +276,24 @@ const all: RawGovernanceConfig<'built-in'> = {
276276
arazzo1Rules: {
277277
'criteria-unique': 'error',
278278
'no-criteria-xpath': 'off',
279+
'no-enum-type-mismatch': 'error',
280+
'no-required-schema-properties-undefined': 'error',
281+
'no-schema-type-mismatch': 'error',
282+
'no-x-security-both-scheme-and-scheme-name': 'off',
283+
'no-x-security-scheme-name-without-openapi': 'off',
279284
'parameters-unique': 'error',
280285
'requestBody-replacements-unique': 'error',
286+
'respect-supported-versions': 'off',
287+
'sourceDescription-name-unique': 'error',
281288
'sourceDescription-type': 'error',
282-
'step-onSuccess-unique': 'error',
289+
'sourceDescriptions-not-empty': 'error',
283290
'step-onFailure-unique': 'error',
291+
'step-onSuccess-unique': 'error',
284292
'stepId-unique': 'error',
285-
'sourceDescription-name-unique': 'error',
286-
'sourceDescriptions-not-empty': 'error',
287-
'respect-supported-versions': 'off',
288-
'workflowId-unique': 'error',
289293
'workflow-dependsOn': 'error',
290-
'no-x-security-scheme-name-without-openapi': 'off',
291-
'x-security-scheme-required-values': 'off',
292-
'no-required-schema-properties-undefined': 'error',
293-
'no-enum-type-mismatch': 'error',
294-
'no-schema-type-mismatch': 'error',
294+
'workflowId-unique': 'error',
295295
'x-security-scheme-name-reference': 'off',
296-
'no-x-security-both-scheme-and-scheme-name': 'off',
296+
'x-security-scheme-required-values': 'off',
297297
},
298298
overlay1Rules: {
299299
'info-contact': 'error',

packages/core/src/config/minimal.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ const minimal: RawGovernanceConfig<'built-in'> = {
258258
'no-enum-type-mismatch': 'warn',
259259
'no-required-schema-properties-undefined': 'warn',
260260
'no-schema-type-mismatch': 'warn',
261-
'no-x-security-scheme-name-in-workflow': 'off',
261+
'no-x-security-both-scheme-and-scheme-name': 'off',
262262
'no-x-security-scheme-name-without-openapi': 'off',
263263
'parameters-unique': 'off',
264264
'requestBody-replacements-unique': 'off',
@@ -271,6 +271,7 @@ const minimal: RawGovernanceConfig<'built-in'> = {
271271
'stepId-unique': 'error',
272272
'workflow-dependsOn': 'off',
273273
'workflowId-unique': 'error',
274+
'x-security-scheme-name-reference': 'off',
274275
'x-security-scheme-required-values': 'off',
275276
},
276277
overlay1Rules: {

packages/core/src/config/recommended-strict.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ const recommendedStrict: RawGovernanceConfig<'built-in'> = {
258258
'no-enum-type-mismatch': 'error',
259259
'no-required-schema-properties-undefined': 'error',
260260
'no-schema-type-mismatch': 'error',
261-
'no-x-security-scheme-name-in-workflow': 'off',
261+
'no-x-security-both-scheme-and-scheme-name': 'off',
262262
'no-x-security-scheme-name-without-openapi': 'off',
263263
'parameters-unique': 'error',
264264
'requestBody-replacements-unique': 'error',
@@ -271,6 +271,7 @@ const recommendedStrict: RawGovernanceConfig<'built-in'> = {
271271
'stepId-unique': 'error',
272272
'workflow-dependsOn': 'error',
273273
'workflowId-unique': 'error',
274+
'x-security-scheme-name-reference': 'off',
274275
'x-security-scheme-required-values': 'off',
275276
},
276277
overlay1Rules: {

packages/core/src/config/recommended.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ const recommended: RawGovernanceConfig<'built-in'> = {
258258
'no-enum-type-mismatch': 'error',
259259
'no-required-schema-properties-undefined': 'warn',
260260
'no-schema-type-mismatch': 'error',
261-
'no-x-security-scheme-name-in-workflow': 'off',
261+
'no-x-security-both-scheme-and-scheme-name': 'off',
262262
'no-x-security-scheme-name-without-openapi': 'off',
263263
'parameters-unique': 'error',
264264
'requestBody-replacements-unique': 'warn',
@@ -271,6 +271,7 @@ const recommended: RawGovernanceConfig<'built-in'> = {
271271
'stepId-unique': 'error',
272272
'workflow-dependsOn': 'error',
273273
'workflowId-unique': 'error',
274+
'x-security-scheme-name-reference': 'off',
274275
'x-security-scheme-required-values': 'off',
275276
},
276277
overlay1Rules: {

packages/core/src/config/spec.ts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -258,7 +258,7 @@ const spec: RawGovernanceConfig<'built-in'> = {
258258
'no-enum-type-mismatch': 'off',
259259
'no-required-schema-properties-undefined': 'off',
260260
'no-schema-type-mismatch': 'off',
261-
'no-x-security-scheme-name-in-workflow': 'off',
261+
'no-x-security-both-scheme-and-scheme-name': 'off',
262262
'no-x-security-scheme-name-without-openapi': 'off',
263263
'parameters-unique': 'error',
264264
'requestBody-replacements-unique': 'error',
@@ -271,6 +271,7 @@ const spec: RawGovernanceConfig<'built-in'> = {
271271
'stepId-unique': 'error',
272272
'workflow-dependsOn': 'error',
273273
'workflowId-unique': 'error',
274+
'x-security-scheme-name-reference': 'off',
274275
'x-security-scheme-required-values': 'off',
275276
},
276277
overlay1Rules: {

0 commit comments

Comments
 (0)