Skip to content

DereferencedPathItem

mattpolzin edited this page Jun 11, 2021 · 4 revisions

DereferencedPathItem

An OpenAPI.PathItem type that guarantees its parameters and operations are inlined instead of referenced.

@dynamicMemberLookup
public struct DereferencedPathItem: Equatable 

Inheritance

Equatable

Nested Type Aliases

Map

public typealias Map = OrderedDictionary<OpenAPI.Path, DereferencedPathItem>

Properties

underlyingPathItem

The original OpenAPI.PathItem prior to being dereferenced.

public let underlyingPathItem: OpenAPI.PathItem

parameters

The dereferenced list of parameters.

public let parameters: [DereferencedParameter]

get

The dereferenced GET operation, if defined.

public let get: DereferencedOperation?

put

The dereferenced PUT operation, if defined.

public let put: DereferencedOperation?

post

The dereferenced POST operation, if defined.

public let post: DereferencedOperation?

delete

The dereferenced DELETE operation, if defined.

public let delete: DereferencedOperation?

options

The dereferenced OPTIONS operation, if defined.

public let options: DereferencedOperation?

head

The dereferenced HEAD operation, if defined.

public let head: DereferencedOperation?

patch

The dereferenced PATCH operation, if defined.

public let patch: DereferencedOperation?

trace

The dereferenced TRACE operation, if defined.

public let trace: DereferencedOperation?

endpoints

Get all endpoints defined at this path.

public var endpoints: [Endpoint] 

Returns

An array of Endpoints with the method (i.e. .get) and the operation for the method.

Methods

`for`(_:)

Retrieve the operation for the given verb, if one is set for this path.

public func `for`(_ verb: OpenAPI.HttpMethod) -> DereferencedOperation? 
Types
Protocols
Global Functions
Extensions
Clone this wiki locally