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.



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

def initialize
  @parameters = {}
end

Class Method Details

.parse(parameters) ⇒ Object 



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

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 



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

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

#add_param(pname, pvalue) ⇒ Object

Raises:

  • (ArgumentError) 


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

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

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

  @parameters[pname] = pvalue
end

#as_swagger ⇒ Object 



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

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 



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

def params
  @parameters.keys
end