Class: Swagger::Data::Parameters

Inherits:
Object
  • Object
show all
Defined in:
lib/ruby-swagger/data/parameters.rb

Overview

github.com/swagger-api/swagger-spec/blob/master/versions/2.0.md#parametersDefinitionsObject

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Object

attr_swagger, #bulk_set, #swagger_attributes, #to_json, #to_swagger, #to_yaml

Constructor Details

#initialize ⇒ Parameters

Returns a new instance of Parameters.



6
7
8
 
# File 'lib/ruby-swagger/data/parameters.rb', line 6

def initialize
  @parameters = {}
end

Class Method Details

.parse(parameters) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/ruby-swagger/data/parameters.rb', line 10

def self.parse(parameters)
  return nil unless parameters

  params = Swagger::Data::Parameters.new

  parameters.each do |pname, pvalue|
    params.add_param(pname, pvalue)
  end

  params
end

Instance Method Details

#[](pname) ⇒ Object 



33
34
35
 
# File 'lib/ruby-swagger/data/parameters.rb', line 33

def [](pname)
  @parameters[pname]
end

#add_param(pname, pvalue) ⇒ Object

Raises:

  • (ArgumentError) 


22
23
24
25
26
27
28
29
30
31
 
# File 'lib/ruby-swagger/data/parameters.rb', line 22

def add_param(pname, pvalue)
  raise ArgumentError.new('Swagger::Data::Parameters#add_param - parameter name is nil') unless pname
  raise ArgumentError.new('Swagger::Data::Parameters#add_param - parameter value is nil') unless pvalue

  unless pvalue.is_a?(Swagger::Data::Parameter)
    pvalue = Swagger::Data::Parameter.parse(pvalue)
  end

  @parameters[pname] = pvalue
end

#as_swagger ⇒ Object 



41
42
43
44
45
46
47
48
49
 
# File 'lib/ruby-swagger/data/parameters.rb', line 41

def as_swagger
  swagger_params = {}

  @parameters.each do |p_k, p_v|
    swagger_params[p_k] = p_v.to_swagger
  end

  swagger_params
end

#params ⇒ Object 



37
38
39
 
# File 'lib/ruby-swagger/data/parameters.rb', line 37

def params
  @parameters.keys
end