mirror of https://github.com/LukeHagar/redocly-cli.git synced 2025-12-06 04:21:09 +00:00

Files

Lorna Jane Mitchell de80612b55 chore: Run prettier on all docs files (#1334 )

2023-11-17 09:45:03 +00:00

2.0 KiB

Raw Blame History

slug

slug
/docs/cli/rules/no-unresolved

no-unresolved-refs

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

OAS	Compatibility
2.0	✅
3.0	✅
3.1	✅

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

Option	Type	Description
severity	string	Possible 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

Rule source
Read our guide on how to use JSON references ($refs)

2.0 KiB Raw Blame History