Skip to content

Commit 198c7fe

Browse files
JLekawavadyvas
authored andcommitted
Apply suggestions from code review
1 parent ee3f3a3 commit 198c7fe

File tree

3 files changed

+7
-4
lines changed

3 files changed

+7
-4
lines changed

.changeset/neat-numbers-knock.md

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

6-
Support `schemeName` in `x-security` at the workflow level (Arazzo). Added new lint rules: `arazzo/no-x-security-both-scheme-and-scheme-name` and `arazzo/x-security-scheme-name-link`. Updated core configs to include new rules.
6+
Added support for `schemeName` in `x-security` at the workflow level (Arazzo). Added new lint rules: `arazzo/no-x-security-both-scheme-and-scheme-name` and `arazzo/x-security-scheme-name-link`. Updated core configs to include new rules.

docs/@v2/rules/arazzo/no-x-security-both-scheme-and-scheme-name.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,8 @@ Forbids using both `scheme` and `schemeName` in the same `x-security` item.
88

99
## Rationale
1010

11-
A single `x-security` item must reference a security scheme in exactly one way: either by embedding the `scheme` object or by referencing it with `schemeName`. Having both is ambiguous and is rejected by the runtime.
11+
A single `x-security` item must reference a security scheme in exactly one way: either by embedding the `scheme` object or by referencing it with `schemeName`.
12+
Having both is ambiguous and is rejected by the runtime.
1213

1314
## Configuration
1415

docs/@v2/rules/arazzo/x-security-scheme-name-link.md

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

3-
When multiple `sourceDescriptions` exist, `workflow.x-security.schemeName` must be a link 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 link to a specific source description (for example, `$sourceDescriptions.{name}.scheme`).
4+
If there is only one source description, a plain string is allowed.
45

56
| Arazzo | Compatibility |
67
| ------ | ------------- |
78
| 1.x ||
89

910
## Design principles
1011

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

1315
## Configuration
1416

0 commit comments

Comments
 (0)