OpenAPI_Parameter_Context

OpenAPI.Parameter.Context

OpenAPI Spec "Parameter Object" location-specific configuration.

public enum Context

See OpenAPI Parameter Locations.

Query, Header, and Cookie parameters are all optional by default unless you pass required: true to the context construction. Path parameters are always required.

Inheritance

Equatable

Enumeration Cases

query

case query(required: Bool, allowEmptyValue: Bool)

header

case header(required: Bool)

path

case path

cookie

case cookie(required: Bool)

Properties

query

An optional query parameter that does not allow empty values.

var query: Context

header

An optional header parameter.

var header: Context

cookie

An optional cookie parameter.

var cookie: Context

inQuery

var inQuery: Bool

inHeader

var inHeader: Bool

inPath

var inPath: Bool

inCookie

var inCookie: Bool

required

var required: Bool

Methods

query(required:)

public static func query(required: Bool) -> Context

query(allowEmptyValue:)

public static func query(allowEmptyValue: Bool) -> Context