Module: Openapi3Parser::Node::ParameterLike

Included in:
Header, Parameter
Defined in:
lib/openapi3_parser/node/parameter_like.rb

Overview

This contains methods that are shared between nodes that act like a Parameter, at the time of writing this was Header and Parameter

Instance Method Summary collapse

Instance Method Details

#allow_empty_value? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/openapi3_parser/node/parameter_like.rb', line 30

def allow_empty_value?
  self["allowEmptyValue"]
end

#allow_reserved? ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
 
# File 'lib/openapi3_parser/node/parameter_like.rb', line 45

def allow_reserved?
  self["allowReserved"]
end

#content ⇒ Map<String, MediaType>?

Returns:



65
66
67
 
# File 'lib/openapi3_parser/node/parameter_like.rb', line 65

def content
  self["content"]
end

#deprecated? ⇒ Boolean

Returns:

  • (Boolean) 


25
26
27
 
# File 'lib/openapi3_parser/node/parameter_like.rb', line 25

def deprecated?
  self["deprecated"]
end

#description ⇒ String

Returns:

  • (String) 


10
11
12
 
# File 'lib/openapi3_parser/node/parameter_like.rb', line 10

def description
  self["description"]
end

#description_html ⇒ String?

Returns:

  • (String, nil) 


15
16
17
 
# File 'lib/openapi3_parser/node/parameter_like.rb', line 15

def description_html
  render_markdown(description)
end

#example ⇒ Any

Returns:

  • (Any) 


55
56
57
 
# File 'lib/openapi3_parser/node/parameter_like.rb', line 55

def example
  self["example"]
end

#examples ⇒ Map<String, Example>?

Returns:



60
61
62
 
# File 'lib/openapi3_parser/node/parameter_like.rb', line 60

def examples
  self["examples"]
end

#explode? ⇒ Boolean

Returns:

  • (Boolean) 


40
41
42
 
# File 'lib/openapi3_parser/node/parameter_like.rb', line 40

def explode?
  self["explode"]
end

#required? ⇒ Boolean

Returns:

  • (Boolean) 


20
21
22
 
# File 'lib/openapi3_parser/node/parameter_like.rb', line 20

def required?
  self["required"]
end

#schema ⇒ Schema?

Returns:



50
51
52
 
# File 'lib/openapi3_parser/node/parameter_like.rb', line 50

def schema
  self["schema"]
end

#style ⇒ String?

Returns:

  • (String, nil) 


35
36
37
 
# File 'lib/openapi3_parser/node/parameter_like.rb', line 35

def style
  self["style"]
end