Contents

require 'swagger/swagger_object'

module Swagger
  module V2
    # Class representing a Swagger "Parameter Object".
    # @see https://github.com/wordnik/swagger-spec/blob/master/versions/2.0.md#parameterObject Parameter Object
    class Parameter < SwaggerObject
      # @!group Fixed Fields
      required_field :name, String
      # required_field :in, String
      field :in, String
      field :description, String
      field :required, Swagger::Boolean
      alias_method :required?, :required
      # @!endgroup

      # @!group Body Fields
      field :schema, Schema
      # @!endgroup

      # @!group Non-Body Fields
      field :type, String
      field :format, String
      field :items, Hash # TODO: Items Object
      field :collectionFormat, String
      field :default, Object
      # @!endgroup

      include DeterministicJSONSchema
    end
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
swagger-core-0.2.3	lib/swagger/v2/parameter.rb
swagger-core-0.2.2	lib/swagger/v2/parameter.rb