Skip to content

LocallyDereferenceable

mattpolzin edited this page Aug 21, 2023 · 6 revisions

LocallyDereferenceable

A dereferenceable type can be recursively looked up in the OpenAPI.Components until there are no JSONReferences left in it or any of its properties.

public protocol LocallyDereferenceable 

Default Implementations

dereferenced(in:)

public func dereferenced(in components: OpenAPI.Components) throws -> DereferencedSelf 

Requirements

DereferencedSelf

associatedtype DereferencedSelf

dereferenced(in:​)

Remove all references from self by looking up each reference in the given Components Object.

func dereferenced(in components: OpenAPI.Components) throws -> DereferencedSelf

Throws

Can also throw ReferenceCycleError if a reference cycle is encountered while dereferencing this component.

_dereferenced(in:​following:​dereferencedFromComponentNamed:​)

An internal-use method that facilitates reference cycle detection by tracking past references followed in the course of dereferencing.

func _dereferenced(
        in components: OpenAPI.Components,
        following references: Set<AnyHashable>,
        dereferencedFromComponentNamed name: String?
    ) throws -> DereferencedSelf

For all external-use, see dereferenced(in:) (provided by the LocallyDereferenceable protocol). All types that provide a _dereferenced(in:following:) implementation have a dereferenced(in:) implementation for free.

Types
Protocols
Global Functions
Extensions
Clone this wiki locally