Skip to content

OpenAPI_ExternalDocumentation

mattpolzin edited this page Jun 11, 2021 · 4 revisions

OpenAPI.ExternalDocumentation

OpenAPI Spec "External Documentation Object"

public struct ExternalDocumentation: Equatable, CodableVendorExtendable 

See OpenAPI External Documentation Object.

Inheritance

CodableVendorExtendable, Decodable, Encodable, Equatable

Initializers

init(description:url:vendorExtensions:)

public init(
            description: String? = nil,
            url: URL,
            vendorExtensions: [String: AnyCodable] = [:]
        ) 

init(from:)

public init(from decoder: Decoder) throws 

Properties

description

public var description: String?

url

public var url: URL

vendorExtensions

Dictionary of vendor extensions.

public var vendorExtensions: [String: AnyCodable]

These should be of the form: [ "x-extensionKey": <anything>] where the values are anything codable.

Methods

encode(to:)

public func encode(to encoder: Encoder) throws 
Types
Protocols
Global Functions
Extensions
Clone this wiki locally