Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Ref

JsonObject $ref resolver. This interface is used to resolve $ref in a . The result is a new with all the $ref replaced by actual object references.

This new object allows navigation and queries using {@link JsonPointer} but will not be able to be encoded back to JSON when circular dependencies are present.

The resolver will only resolve local references as defined in RFC3986. A local reference is a reference that starts with # and is followed by a valid JSON Pointer.

Hierarchy

  • Ref

Index

Methods

Methods

Static resolve

  • resolve(json: {}): {}
  • Resolve all $ref in the given . The resolution algorithm is not aware of other specifications. When resolving OpenAPI documents (which only allow $ref at specific locations) you should validate if the document is valid before performing a resolution.

    It is important to note that any sibling elements of a $ref is ignored. This is because $ref works by replacing itself and everything on its level with the definition it is pointing at.

    Parameters

    • json: {}
      • [key: string]: any

    Returns {}

    • [key: string]: any

Generated using TypeDoc