Skip to content
Last updated

no-unresolved-refs

Ensures that all $ref instances in your API descriptions are resolved.

OASCompatibility
2.0✅
3.0✅
3.1✅
3.2✅
AsyncAPICompatibility
2.6✅
3.0✅
ArazzoCompatibility
1.x✅
OverlayCompatibility
1.x✅

The default setting for this rule (in the spec, recommended, and minimal configuration) is error.

API design principles

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.

Configuration

OptionTypeDescription
severitystringPossible values: off, warn, error. Default error (in recommended configuration).

An example configuration:

rules:
  no-unresolved-refs: error

Examples

Given this configuration:

rules:
  no-unresolved-refs: error

Example 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: string

Example 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

Resources

 
Next page