Class: Swagger::Data::Definitions

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

Overview

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

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 ⇒ Definitions

Returns a new instance of Definitions.



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

def initialize
  @definitions = {}
end

Class Method Details

.parse(definitions) ⇒ Object 



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

def self.parse(definitions)
  return nil unless definitions

  definition = Swagger::Data::Definitions.new

  definitions.each do |definition_name, definition_value|
    definition.add_definition(definition_name, definition_value)
  end

  definition
end

Instance Method Details

#[](key) ⇒ Object 



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

def [](key)
  @definitions[key]
end

#add_definition(definition_name, definition_value) ⇒ Object

Raises:

  • (ArgumentError) 


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

def add_definition(definition_name, definition_value)
  raise ArgumentError.new("Swagger::Data::Definitions#add_definition - definition_name is nil") unless definition_name
  raise ArgumentError.new("Swagger::Data::Definitions#add_definition - definition_value is nil") unless definition_value

  if !definition_value.is_a?(Swagger::Data::Schema)
    definition_value = Swagger::Data::Schema.parse(definition_value)
  end

  @definitions[definition_name] = definition_value
end

#as_swagger ⇒ Object 



38
39
40
41
42
43
44
45
46
 
# File 'lib/ruby-swagger/data/definitions.rb', line 38

def as_swagger
  swagger_defs = {}

  @definitions.each do |def_k, def_v|
    swagger_defs[def_k] = def_v.to_swagger
  end

  swagger_defs
end