Skip to content

OpenAPI_Parameter_SchemaContext

mattpolzin edited this page Aug 26, 2023 · 15 revisions

Extensions on OpenAPI.Parameter.SchemaContext

Initializers

init(from:for:)

public init(from decoder: Decoder, for location: OpenAPI.Parameter.Context) throws 

Methods

header(_:allowReserved:example:)

public static func header(
        _ schema: JSONSchema,
        allowReserved: Bool = false,
        example: AnyCodable? = nil
    ) -> Self 

header(schemaReference:allowReserved:example:)

public static func header(
        schemaReference: JSONReference<JSONSchema>,
        allowReserved: Bool = false,
        example: AnyCodable? = nil
    ) -> Self 

header(_:allowReserved:examples:)

public static func header(
        _ schema: JSONSchema,
        allowReserved: Bool = false,
        examples: OpenAPI.Example.Map?
    ) -> Self 

header(schemaReference:allowReserved:examples:)

public static func header(
        schemaReference: JSONReference<JSONSchema>,
        allowReserved: Bool = false,
        examples: OpenAPI.Example.Map?
    ) -> Self 

encode(to:for:)

public func encode(to encoder: Encoder, for location: OpenAPI.Parameter.Context) throws 

_dereferenced(in:following:dereferencedFromComponentNamed:)

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

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

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