Home

Types

• AnyCodable: A type-erased Codable value.
• OpenAPI.Components.ReferenceError
• OpenAPI.Components: OpenAPI Spec "Components Object".
• OpenAPI.ComponentKey
• OpenAPI.Content: OpenAPI Spec "Media Type Object"
• OpenAPI.Content.Encoding: OpenAPI Spec "Encoding Object"
• OpenAPI.ContentType
• OpenAPI.Discriminator: OpenAPI Spec "Disciminator Object"
• OpenAPI.Document: The root of an OpenAPI 3.0 document.
• OpenAPI.Document.Route: A Route is the combination of a path (where the route lives) and a path item (the definition of the route).
• OpenAPI.Document.Version
• OpenAPI.Document.Info: OpenAPI Spec "Info Object"
• OpenAPI.Document.Info.Contact: OpenAPI Spec "Contact Object"
• OpenAPI.Document.Info.License: OpenAPI Spec "License Object"
• EitherDecodeNoTypesMatchedError
• EitherDecodeNoTypesMatchedError.IndividualFailure
• Either
• OpenAPI.Error.Decoding.Document
• OpenAPI.Error.Decoding.Document.Context
• InconsistencyError: This error type is thrown when a problem during encoding or decoding but the problem is not inherent to the types or structures but rather specific to the OpenAPI specification rules.
• OpenAPI.Error.Decoding
• ErrorCategory
• ErrorCategory.KeyValue
• OpenAPI.Error: An OpenAPI.Error can be constructed from any error thrown while decoding an OpenAPI document. This wrapper provides a superior human-readable error and a human readable coding path.
• OpenAPI.Error.Decoding.Operation
• OpenAPI.Error.Decoding.Operation.Context
• OpenAPI.Error.Decoding.Path
• OpenAPI.Error.Decoding.Path.Context
• OpenAPI.Error.Decoding.Request
• OpenAPI.Error.Decoding.Request.Context
• OpenAPI.Error.Decoding.Response
• OpenAPI.Error.Decoding.Response.Context
• OpenAPI.Example: OpenAPI Spec "Example Object"
• OpenAPI.ExternalDocumentation: OpenAPI Spec "External Documentation Object"
• OpenAPI.Header: OpenAPI Spec "Header Object"
• OpenAPI.HttpMethod: Represents the HTTP methods supported by the OpenAPI Specification.
• JSONReference: A JSON Reference which represents something like
• JSONReference.InternalReference
• JSONReference.Path: A JSON Reference path.
• JSONReference.PathComponent: A JSON Reference path component, as described by the JSON pointer specification.
• OpenAPI.OAuthFlows: OpenAPI Spec "Oauth Flows Object"
• OpenAPI.OAuthFlows.CommonFields
• OpenAPI.OAuthFlows.Implicit
• OpenAPI.OAuthFlows.Password
• OpenAPI.OAuthFlows.ClientCredentials
• OpenAPI.OAuthFlows.AuthorizationCode
• OpenAPI: The OpenAPI namespace
• OpenAPI.Operation: OpenAPI Spec "Operation Object"
• OpenAPI.Operation.ResponseOutcome: A ResponseOutcome is the combination of a status code and a response.
• OrderedDictionary: A simple implementation of an Ordered Dictionary based on the existing Foundation Dictionary and Array types. Undoubtedly not the fastest performer, but should be sufficient for the purposes of this library.
• OrderedDictionary.Iterator
• OpenAPI.Parameter: OpenAPI Spec "Parameter Object"
• OpenAPI.Parameter.Context: OpenAPI Spec "Parameter Object" location-specific configuration.
• OpenAPI.Parameter.Context.Location
• OpenAPI.Parameter.SchemaContext: OpenAPI Spec "Parameter Object" schema and style configuration.
• OpenAPI.Parameter.SchemaContext.Style
• OpenAPI.Path: OpenAPI Spec "Paths Object" path field pattern support.
• OpenAPI.PathItem: OpenAPI Spec "Path Item Object"
• OpenAPI.PathItem.Endpoint: An Endpoint is the combination of an HTTP method and an operation.
• OpenAPI.Request: OpenAPI Spec "Request Body Object"
• OpenAPI.Response: OpenAPI Spec "Response Object"
• OpenAPI.Response.StatusCode: An HTTP Status code or status code range.
• OpenAPI.Response.StatusCode.Range
• JSONSchemaFragment
• JSONSchemaFragment.GeneralContext
• JSONSchemaFragment.IntegerContext
• JSONSchemaFragment.NumericContext
• JSONSchemaFragment.StringContext
• JSONSchemaFragment.ArrayContext
• JSONSchemaFragment.ObjectContext
• JSONSchema: OpenAPI "Schema Object"
• JSONSchema.Context: The context that applies to all schemas.
• JSONSchema.Context.Permissions
• JSONSchema.NumericContext: The context that only applies to .number schemas.
• JSONSchema.NumericContext.Bound
• JSONSchema.IntegerContext: The context that only applies to .integer schemas.
• JSONSchema.IntegerContext.Bound
• JSONSchema.StringContext: The context that only applies to .string schemas.
• JSONSchema.ArrayContext: The context that only applies to .array schemas.
• JSONSchema.ObjectContext: The context that only applies to .object schemas.
• JSONType
• JSONTypeFormat
• JSONTypeFormat.BooleanFormat: The allowed "format" properties for .boolean schemas.
• JSONTypeFormat.ObjectFormat: The allowed "format" properties for .object schemas.
• JSONTypeFormat.ArrayFormat: The allowed "format" properties for .array schemas.
• JSONTypeFormat.NumberFormat: The allowed "format" properties for .number schemas.
• JSONTypeFormat.IntegerFormat: The allowed "format" properties for .integer schemas.
• JSONTypeFormat.StringFormat: The allowed "format" properties for .string schemas.
• JSONTypeFormat.StringFormat.Extended: Popular non-standard "format" properties for .string schemas.
• JSONTypeFormat.IntegerFormat.Extended: Popular non-standard "format" properties for .integer schemas.
• OpenAPI.SecurityScheme: OpenAPI Spec "Security Scheme Object"
• OpenAPI.SecurityScheme.SecurityType
• OpenAPI.SecurityScheme.Location
• OpenAPI.SecurityScheme.SecurityType.Name
• OpenAPI.Server: OpenAPI Spec "Server Object"
• OpenAPI.Server.Variable: OpenAPI Spec "Server Variable Object"
• OpenAPI.Tag: OpenAPI Spec "Tag Object"
• OpenAPI.XML: OpenAPI Spec "XML Object"

Protocols

• VendorExtendable: A VendorExtendable type is a type that supports arbitrary additions as long as those additions are keyed by strings starting with "x-" (e.g. "x-customThing").
• ComponentDictionaryLocatable: Anything conforming to ComponentDictionaryLocatable knows where to find resources of its type in the Components Dictionary.
• OpenAPIError
• _OpenAPIReference: Used as a quick check internally in this library to determine if a type is a reference (which only JSONReference should be).
• OpenAPISchemaType: Anything conforming to OpenAPISchemaType can provide an OpenAPI schema representing itself.
• JSONSchemaFragmentContext
• JSONSchemaContext: A schema context stores information about a schema. All schemas can have the contextual information in this protocol.
• SwiftTyped
• OpenAPIFormat