Class: SwaggerParser::Parameter

Inherits:
JsonSchema show all
Includes:
Extendable
Defined in:
lib/swagger_parser/parameter.rb

Instance Attribute Summary

Attributes inherited from SourceBasedObject

#source

Instance Method Summary collapse

Methods included from Extendable

#extensions

Methods inherited from JsonSchema

#max_properties, #min_properties

Methods included from Referable

#ref

Methods inherited from MinimalJsonSchema

#default, #description, #enum, #exclusive_maximum, #exclusive_minimum, #format, #maxItems, #max_length, #maximum, #min_items, #min_length, #minimum, #multiple_of, #pattern, #title, #type, #unique_items

Methods inherited from SourceBasedObject

#initialize

Constructor Details

This class inherits a constructor from SwaggerParser::SourceBasedObject

Instance Method Details

#allow_empty_value ⇒ Object 



10
11
12
 
# File 'lib/swagger_parser/parameter.rb', line 10

def allow_empty_value
  source["allowEmptyValue"]
end

#boolean ⇒ Object 



15
16
17
 
# File 'lib/swagger_parser/parameter.rb', line 15

def boolean
  source["boolean"]
end

#collection_format ⇒ Object 



20
21
22
 
# File 'lib/swagger_parser/parameter.rb', line 20

def collection_format
  source["collectionFormat"]
end

#in ⇒ Object 



25
26
27
 
# File 'lib/swagger_parser/parameter.rb', line 25

def in
  source["in"]
end

#items ⇒ Array<SwaggerParser::Items>? 



30
31
32
33
34
 
# File 'lib/swagger_parser/parameter.rb', line 30

def items
  if source["items"]
    SwaggerParser::Item.new(source["items"])
  end
end

#name ⇒ Object 



37
38
39
 
# File 'lib/swagger_parser/parameter.rb', line 37

def name
  source["name"]
end

#required ⇒ false, true

Note:

Override because this “required” is different from JSON Schema’s “required”



43
44
45
 
# File 'lib/swagger_parser/parameter.rb', line 43

def required
  !!source["required"]
end

#schema ⇒ Object 



48
49
50
51
 
# File 'lib/swagger_parser/parameter.rb', line 48

def schema
  value = source["schema"]
  SwaggerParser::Schema.new(value) if in_body?
end