Contents

module SwaggerYard
  class Parameter
    attr_accessor :name, :type, :description, :param_type, :required, :allow_multiple

    def self.from_yard_tag(tag, operation)
      name, options_string = tag.name.split(/[\(\)]/)
      description = tag.text
      description = name if description.strip.empty?
      type = Type.from_type_list(tag.types)

      options = {}

      operation.model_names << type.name if type.ref?

      unless options_string.nil?
        options_string.split(',').map(&:strip).tap do |arr|
          options[:required] = !arr.delete('required').nil?
          options[:allow_multiple] = !arr.delete('multiple').nil?
          options[:param_type] = arr.last
        end
      end

      new(name, type, description, options)
    end

    # TODO: support more variation in scope types
    def self.from_path_param(name)
      new(name, Type.new("string"), "Scope response to #{name}", {
        required: true,
        allow_multiple: false,
        param_type: "path",
        from_path: true
      })
    end

    def initialize(name, type, description, options={})
      @name, @type, @description = name, type, description

      @required = options[:required] || false
      @param_type = options[:param_type] || 'query'
      @allow_multiple = options[:allow_multiple] || false
      @from_path      = options[:from_path] || false
    end

    def from_path?
      @from_path
    end

    def to_h
      { "name"        => name,
        "description" => description,
        "required"    => required,
        "in"          => param_type
      }.tap do |h|
        if h["in"] == "body"
          h["schema"] = @type.to_h
        else
          h.update(@type.to_h)
        end
        h["collectionFormat"] = 'multi' if !Array(allow_multiple).empty? && h["items"]
      end
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
swagger_yard-0.4.2	lib/swagger_yard/parameter.rb
swagger_yard-0.4.1	lib/swagger_yard/parameter.rb
swagger_yard-0.4.0	lib/swagger_yard/parameter.rb