Class: Swagger::Data::Items

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

Overview

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

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

Returns a new instance of Items.



11
12
13
 
# File 'lib/ruby-swagger/data/items.rb', line 11

def initialize
  @type = "string"  #we default to an array of strings
end

Class Method Details

.parse(items) ⇒ Object 



15
16
17
18
19
 
# File 'lib/ruby-swagger/data/items.rb', line 15

def self.parse(items)
  return nil if items.nil?

  Swagger::Data::Items.new.bulk_set(items)
end

Instance Method Details

#collectionFormat=(new_collection_format) ⇒ Object

Raises:

  • (ArgumentError) 


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

def collectionFormat=(new_collection_format)
  return nil unless new_collection_format
  raise ArgumentError.new("Swagger::Data::Items#collectionFormat= - collectionFormat #{new_collection_format} is invalid") unless %w(csv ssv tsv pipes).include?(new_collection_format)
  @collectionFormat = new_collection_format
end

#items=(new_items) ⇒ Object

Raises:

  • (ArgumentError) 


28
29
30
31
32
33
34
35
36
 
# File 'lib/ruby-swagger/data/items.rb', line 28

def items=(new_items)
  raise ArgumentError.new("Swagger::Data::Items#items= - is nil") if new_items.nil? && @type == 'array'

  if !new_items.nil? && !new_items.is_a?(Swagger::Data::Items)
    new_items = Swagger::Data::Items.parse(new_items)
  end

  @items = new_items
end

#type=(new_type) ⇒ Object

Raises:

  • (ArgumentError) 


21
22
23
24
25
26
 
# File 'lib/ruby-swagger/data/items.rb', line 21

def type=(new_type)
  raise ArgumentError.new("Swagger::Data::Items#type= - type is nil") unless new_type
  raise ArgumentError.new("Swagger::Data::Items#type= - type #{new_type} is invalid") unless %w(string number integer boolean array).include?(new_type)

  @type = new_type
end