Skip to content

OpenAPI

mattpolzin edited this page Jun 11, 2021 · 5 revisions

OpenAPI

The OpenAPI namespace

public enum OpenAPI 

Nested Type Aliases

Callbacks

A map from runtime expressions to path items to be used as callbacks for the API.

public typealias Callbacks = OrderedDictionary<CallbackURL, PathItem>

See OpenAPI Callback Object.

CallbacksMap

A map of named collections of Callback Objects (OpenAPI.Callbacks).

public typealias CallbacksMap = OrderedDictionary<String, Either<JSONReference<Callbacks>, Callbacks>>

ComponentDictionary

public typealias ComponentDictionary<T> = OrderedDictionary<ComponentKey, T>

SecurityRequirement

OpenAPI Spec "Security Requirement Object"

public typealias SecurityRequirement = [JSONReference<SecurityScheme>: [String]]

If the security scheme is of type "oauth2" or "openIdConnect", then the value is a list of scope names required for the execution. For other security scheme types, the array MUST be empty.

Multiple entries in this dictionary indicate all schemes named are required on the same request.

See OpenAPI Security Requirement Object.

Types
Protocols
Global Functions
Extensions
Clone this wiki locally