Skip to content

DereferencedOperation

mattpolzin edited this page Jun 11, 2021 · 4 revisions

DereferencedOperation

An OpenAPI.Operation type that guarantees its parameters, requestBody, responses, and security are inlined instead of referenced.

@dynamicMemberLookup
public struct DereferencedOperation: Equatable 

Inheritance

Equatable

Properties

underlyingOperation

The original OpenAPI.Operation prior to being dereferenced.

public let underlyingOperation: OpenAPI.Operation

parameters

A dereferenced array of parameters.

public let parameters: [DereferencedParameter]

requestBody

A dereferenced request body.

public let requestBody: DereferencedRequest?

responses

A dereferenced map of responses.

public let responses: DereferencedResponse.Map

security

An array of dereferenced security requirements.

public let security: [DereferencedSecurityRequirement]?

If defined, overrides the security requirements in the root document security array.

Each secutity requirement in this array is an alternative, only one of which must be met for the request to be authorized.

By contrast, all entries in an individual DereferencedSecurityRequirement (which is itself a dictionary) must be met.

nil indicates this operation uses the security requirements defined at the root of the document.

responseOutcomes

Get all response outcomes for this operation.

public var responseOutcomes: [ResponseOutcome] 

Returns

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

Types
Protocols
Global Functions
Extensions
Clone this wiki locally