OpenAPI_Operation

OpenAPI.Operation

OpenAPI Spec "Operation Object"

public struct Operation: Equatable, CodableVendorExtendable

See OpenAPI Operation Object.

Inheritance

CodableVendorExtendable, Decodable, Encodable, Equatable

Initializers

init(tags:summary:description:externalDocs:operationId:parameters:requestBody:responses:deprecated:security:servers:vendorExtensions:)

public init(tags: [String]? = nil, summary: String? = nil, description: String? = nil, externalDocs: OpenAPI.ExternalDocumentation? = nil, operationId: String? = nil, parameters: Parameter.Array = [], requestBody: Either<JSONReference<OpenAPI.Request>, OpenAPI.Request>, responses: OpenAPI.Response.Map, deprecated: Bool = false, security: [OpenAPI.SecurityRequirement]? = nil, servers: [OpenAPI.Server]? = nil, vendorExtensions: [String: AnyCodable] = [:])

init(tags:summary:description:externalDocs:operationId:parameters:requestBody:responses:deprecated:security:servers:vendorExtensions:)

public init(tags: [String]? = nil, summary: String? = nil, description: String? = nil, externalDocs: OpenAPI.ExternalDocumentation? = nil, operationId: String? = nil, parameters: Parameter.Array = [], requestBody: OpenAPI.Request? = nil, responses: OpenAPI.Response.Map, deprecated: Bool = false, security: [OpenAPI.SecurityRequirement]? = nil, servers: [OpenAPI.Server]? = nil, vendorExtensions: [String: AnyCodable] = [:])

init(tags:summary:description:externalDocs:operationId:parameters:requestBody:responses:deprecated:security:servers:vendorExtensions:)

public init(tags: String, summary: String? = nil, description: String? = nil, externalDocs: OpenAPI.ExternalDocumentation? = nil, operationId: String? = nil, parameters: Parameter.Array = [], requestBody: OpenAPI.Request? = nil, responses: OpenAPI.Response.Map, deprecated: Bool = false, security: [OpenAPI.SecurityRequirement]? = nil, servers: [OpenAPI.Server]? = nil, vendorExtensions: [String: AnyCodable] = [:])

init(from:)

public init(from decoder: Decoder) throws

Properties

tags

var tags: [String]?

summary

var summary: String?

description

var description: String?

externalDocs

var externalDocs: OpenAPI.ExternalDocumentation?

operationId

var operationId: String?

parameters

var parameters: Parameter.Array

requestBody

var requestBody: Either<JSONReference<OpenAPI.Request>, OpenAPI.Request>?

responses

var responses: OpenAPI.Response.Map

deprecated

var deprecated: Bool

security

var security: [OpenAPI.SecurityRequirement]?

servers

var servers: [OpenAPI.Server]?

vendorExtensions

Dictionary of vendor extensions.

var vendorExtensions: [String: AnyCodable]

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

responseOutcomes

Get all response outcomes for this operation.

var responseOutcomes: [ResponseOutcome]

Returns

An array of ResponseOutcomes with the status and the response for the status.

Methods

encode(to:)

public func encode(to encoder: Encoder) throws