OperationModel

struct OperationModel
extension OperationModel: CustomStringConvertible

Model for operations of endpoint

  • identifier from OpenAPI document

    Declaration

    Swift

    var operationId: String

  • comment

    Declaration

    Swift

    var detail: String?

  • method as stated in document

    Declaration

    Swift

    var httpMethod: OpenAPI.HttpMethod

  • path where method is located

    Declaration

    Swift

    var path: OpenAPI.Path

  • list of parameters for this method

    Declaration

    Swift

    var parameters: [ParameterModel]?

  • true if method requires authentication

    Declaration

    Swift

    var requiresAuth: Bool

  • request body for this method if available

    Declaration

    Swift

    var requestBody: RequestBodyModel?

  • responses (errors and success) for this method

    Declaration

    Swift

    var responses: [ResponseModel]

  • success type for this method

    Declaration

    Swift

    var successType: String { get }

  • list of possible failures for this method

    Declaration

    Swift

    var failures: [ResponseModel] { get }

  • explicit failure type

    Declaration

    Swift

    var failureType: String { get }

  • Resolves operations from open api document

    Declaration

    Swift

    static func resolve(endpoint: ResolvedEndpoint) -> OperationModel

    Parameters

    endpoint

    endpoint in which this method is located

    Return Value

    operation model

  • Undocumented

    Declaration

    Swift

    var comment: String { get }

  • mapping for failures of method

    Declaration

    Swift

    var failureTryMap: String { get }

  • success decoding for method

    Declaration

    Swift

    var successDecoding: String { get }

  • changes content type if request body is in binary format

    Declaration

    Swift

    var specialContentType: String? { get }

  • description for this methods NetworkManager call

    Declaration

    Swift

    var operationDescription: String { get }

  • Declaration

    Swift

    var description: String { get }