Ensures that all $ref instances in your API descriptions are resolved.
| OAS | Compatibility |
|---|---|
| 2.0 | ✅ |
| 3.0 | ✅ |
| 3.1 | ✅ |
| AsyncAPI | Compatibility |
|---|---|
| 2.6 | ✅ |
| 3.0 | ✅ |
| Arazzo | Compatibility |
|---|---|
| 1.x | ✅ |
| Overlay | Compatibility |
|---|---|
| 1.x | ✅ |
The default setting for this rule (in the spec, recommended, and minimal configuration) is error.
The $ref (reference object) is useful for keeping your OpenAPI descriptions DRY (don't repeat yourself). But if you make a typo, your $ref might not be resolvable. This rule prevents that from happening.
| Option | Type | Description |
|---|---|---|
| severity | string | Possible values: off, warn, error. Default error (in recommended configuration). |
An example configuration:
rules:
no-unresolved-refs: errorGiven this configuration:
rules:
no-unresolved-refs: errorExample of an incorrect $ref:
components:
schemas:
Car:
type: object
properties:
color:
type: string
tires:
$ref: '#/components/schemas/Tires'
Tire:
type: object
properties:
name:
type: string
size:
type: stringExample of a correct $ref:
components:
schemas:
Car:
type: object
properties:
color:
type: string
tires:
$ref: '#/components/schemas/Tire'
Tire:
type: object
properties:
name:
type: string
size:
type: string- Rule source
- Read our guide on how to use JSON references ($refs)