ParameterModel

struct ParameterModel : CustomStringConvertible

model for parameters

  • Declaration

    Swift

    var description: String { get }

  • name of this parameter

    Declaration

    Swift

    var name: String

  • type of this parameter

    Declaration

    Swift

    var type: String

  • comment for this parameter

    Declaration

    Swift

    var detail: String?

  • default value for this parameter

    Declaration

    Swift

    var defaultValue: String?

  • location of parameter (header, query, cookie, path)

    Declaration

    Swift

    var location: Location

  • true if param is required in specification

    Declaration

    Swift

    var required: Bool
  • min

    minMax values as specified in OpenAPI document e.g. minMaxLength for Strings or minMax for Integers

    Declaration

    Swift

    var min: Int?
  • max

    Undocumented

    Declaration

    Swift

    var max: Int?

  • description inside method body

    Declaration

    Swift

    var opDescription: String { get }

  • Undocumented

    See more

    Declaration

    Swift

    enum LimitError : Error

  • provides the guard code block for ensuring that a parameter is in the required range.

    Declaration

    Swift

    var limitGuard: String? { get }

  • Possible location of parameters

    See more

    Declaration

    Swift

    enum Location : Equatable

  • Resolves parameter from OpenAPI document operation

    Declaration

    Swift

    static func resolve(param: DereferencedParameter) -> ParameterModel

    Parameters

    param

    Parameter from OpenAPI document

    Return Value

    ParameterModel object