OpenAPI
The OpenAPI namespace
enum OpenAPI
The OpenAPI namespace
enum OpenAPI
import OpenAPIKit
struct Components
OpenAPI Spec “Components Object”.
struct Content
OpenAPI Spec “Media Type Object”
enum ContentEncoding
An encoding, as specified in RFC 2045, part 6.1 and RFC 4648.
struct Document
The root of an OpenAPI 3.1 document.
struct Example
OpenAPI Spec “Example Object”
struct ExternalDocumentation
OpenAPI Spec “External Documentation Object”
struct Header
OpenAPI Spec “Header Object”
struct Link
OpenAPI Spec “Link Object”
struct Operation
OpenAPI Spec “Operation Object”
struct Parameter
OpenAPI Spec “Parameter Object”
struct PathItem
OpenAPI Spec “Path Item Object”
@dynamicMemberLookup struct Reference<ReferenceType> where ReferenceType : ComponentDictionaryLocatable
A Reference that carries both a standard JSON Rreference in addition to optionally overriding the summary
and/or description
of the referenced component.
struct Request
OpenAPI Spec “Request Body Object”
struct Response
OpenAPI Spec “Response Object”
enum RuntimeExpression
OpenAPI Spec “Runtime Expression”
struct SecurityScheme
OpenAPI Spec “Security Scheme Object”
struct Server
OpenAPI Spec “Server Object”
struct Tag
OpenAPI Spec “Tag Object”
struct XML
OpenAPI Spec “XML Object”
typealias CallbackURL = OpenAPIKitCore.Shared.CallbackURL
typealias Callbacks = OrderedDictionary<CallbackURL, Either<OpenAPI.Reference<PathItem>, PathItem>>
A map from runtime expressions to path items to be used as callbacks for the API. The OpenAPI Spec “Callback Object.”
typealias CallbacksMap = OrderedDictionary<String, Either<OpenAPI.Reference<Callbacks>, Callbacks>>
A map of named collections of Callback Objects (OpenAPI.Callbacks
).
typealias ComponentDictionary<T> = OrderedDictionary<ComponentKey, T>
typealias ComponentKey = OpenAPIKitCore.Shared.ComponentKey
typealias ContentType = OpenAPIKitCore.Shared.ContentType
typealias DereferencedCallbacks = OrderedDictionary<CallbackURL, DereferencedPathItem>
A dictionary of Dereferenced of callbacks.
typealias DereferencedCallbacksMap = OrderedDictionary<String, DereferencedCallbacks>
A dictionary of Dereferenced map of callbacks.
typealias Discriminator = OpenAPIKitCore.Shared.Discriminator
typealias Error = OpenAPIKitCore.Error
typealias HttpMethod = OpenAPIKitCore.Shared.HttpMethod
typealias OAuthFlows = OpenAPIKitCore.Shared.OAuthFlows
typealias Path = OpenAPIKitCore.Shared.Path
typealias SecurityRequirement = [JSONReference<SecurityScheme> : [String]]
OpenAPI Spec “Security Requirement Object”
typealias Warning = OpenAPIKitCore.Warning