File tree Expand file tree Collapse file tree 8 files changed +23
-10
lines changed
Expand file tree Collapse file tree 8 files changed +23
-10
lines changed Original file line number Diff line number Diff line change @@ -29,7 +29,7 @@ The rules list is split into sections.
2929
3030### Special rules
3131
32- - [ no-unresolved-refs] ( ./oas /no-unresolved-refs.md ) : Every ` $ref ` must exist
32+ - [ no-unresolved-refs] ( ./common /no-unresolved-refs.md ) : Every ` $ref ` must exist
3333- [ no-unused-components] ( ./oas/no-unused-components.md ) : All components must be used
3434- [ security-defined] ( ./oas/security-defined.md ) : Security rules must be defined, either globally or per-operation
3535- [ struct] ( ./common/struct.md ) : Conform to the declared OpenAPI specification version
Original file line number Diff line number Diff line change @@ -12,6 +12,21 @@ Ensures that all `$ref` instances in your API descriptions are resolved.
1212| 3.0 | ✅ |
1313| 3.1 | ✅ |
1414
15+ | AsyncAPI | Compatibility |
16+ | -------- | ------------- |
17+ | 2.6 | ✅ |
18+ | 3.0 | ✅ |
19+
20+ | Arazzo | Compatibility |
21+ | ------ | ------------- |
22+ | 1.x | ✅ |
23+
24+ | Overlay | Compatibility |
25+ | ------- | ------------- |
26+ | 1.x | ✅ |
27+
28+ The default setting for this rule (in the ` spec ` , ` recommended ` , and ` minimal ` configuration) is ` error ` .
29+
1530## API design principles
1631
1732The ` $ref ` (reference object) is useful for keeping your OpenAPI descriptions DRY (don't repeat yourself).
@@ -84,9 +99,9 @@ components:
8499
85100# # Related rules
86101
87- - [struct](../common /struct.md)
102+ - [struct](./struct.md)
88103- [configurable rules](../configurable-rules.md)
89- - [no-unused-components](./no-unused-components.md)
104+ - [no-unused-components](../oas /no-unused-components.md)
90105
91106# # Resources
92107
Original file line number Diff line number Diff line change 11---
22slug : /docs/cli/v2/rules/common/struct
3- # slug: /docs/cli/v2/rules/oas/struct
4- # slug: /docs/cli/v2/rules/arazzo/struct
53---
64
75# struct
Original file line number Diff line number Diff line change @@ -10,7 +10,7 @@ Errors:
1010
1111- [ no-server-trailing-slash] ( ./oas/no-server-trailing-slash.md )
1212- [ no-server-variables-empty-enum] ( ./oas/no-server-variables-empty-enum.md )
13- - [ no-unresolved-refs] ( ./oas /no-unresolved-refs.md )
13+ - [ no-unresolved-refs] ( ./common /no-unresolved-refs.md )
1414- [ struct] ( ./common/struct.md )
1515- [ stepId-unique] ( ./arazzo/stepId-unique.md )
1616- [ workflowId-unique] ( ./arazzo/workflowId-unique.md )
Original file line number Diff line number Diff line change @@ -82,7 +82,7 @@ components:
8282
8383## Related rules
8484
85- - [ no-undefined-refs] ( ./no-unresolved-refs.md )
85+ - [ no-undefined-refs] ( ../common /no-unresolved-refs.md )
8686
8787## Resources
8888
Original file line number Diff line number Diff line change @@ -16,7 +16,7 @@ Errors:
1616- [ no-server-trailing-slash] ( ./oas/no-server-trailing-slash.md )
1717- [ no-server-variables-empty-enum] ( ./oas/no-server-variables-empty-enum.md )
1818- [ no-undefined-server-variable] ( ./oas/no-undefined-server-variable.md )
19- - [ no-unresolved-refs] ( ./oas /no-unresolved-refs.md )
19+ - [ no-unresolved-refs] ( ./common /no-unresolved-refs.md )
2020- [ nullable-type-sibling] ( ./oas/nullable-type-sibling.md )
2121- [ operation-operationId-unique] ( ./oas/operation-operationId-unique.md )
2222- [ operation-operationId-url-safe] ( ./oas/operation-operationId-url-safe.md )
Original file line number Diff line number Diff line change @@ -12,7 +12,7 @@ All the rules are of severity `error`:
1212- [ no-example-value-and-externalValue] ( ./oas/no-example-value-and-externalValue.md )
1313- [ no-identical-paths] ( ./oas/no-identical-paths.md )
1414- [ no-undefined-server-variable] ( ./oas/no-undefined-server-variable.md )
15- - [ no-unresolved-refs] ( ./oas /no-unresolved-refs.md )
15+ - [ no-unresolved-refs] ( ./common /no-unresolved-refs.md )
1616- [ no-x-security-scheme-name-in-workflow] ( ./respect/no-x-security-scheme-name-in-workflow.md )
1717- [ no-x-security-scheme-name-without-openapi] ( ./respect/no-x-security-scheme-name-without-openapi.md )
1818- [ nullable-type-sibling] ( ./oas/nullable-type-sibling.md )
Original file line number Diff line number Diff line change 8484 items :
8585 - separator : Common
8686 - page : rules/common/struct.md
87+ - page : rules/common/no-unresolved-refs.md
8788 - separator : OpenAPI
8889 - page : rules/oas/array-parameter-serialization.md
8990 - page : rules/oas/boolean-parameter-prefixes.md
107108 - page : rules/oas/no-server-trailing-slash.md
108109 - page : rules/oas/no-server-variables-empty-enum.md
109110 - page : rules/oas/no-undefined-server-variable.md
110- - page : rules/oas/no-unresolved-refs.md
111111 - page : rules/oas/no-unused-components.md
112112 - page : rules/oas/nullable-type-sibling.md
113113 - page : rules/oas/operation-2xx-response.md
You can’t perform that action at this time.
0 commit comments