Class: OpenApi::Example

Inherits:
Object
  • Object
show all
Defined in:
lib/open_api/example.rb

Overview

github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#exampleObject

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(summary: nil, description: nil, value: nil, external_value: nil) ⇒ Example

Returns a new instance of Example.



6
7
8
9
10
11
 
# File 'lib/open_api/example.rb', line 6

def initialize(summary: nil, description: nil, value: nil, external_value: nil)
  self.summary = summary
  self.description = description
  self.value = value
  self.external_value = external_value
end

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



4
5
6
 
# File 'lib/open_api/example.rb', line 4

def description
  @description
end

#external_value ⇒ Object

Returns the value of attribute external_value.



4
5
6
 
# File 'lib/open_api/example.rb', line 4

def external_value
  @external_value
end

#summary ⇒ Object

Returns the value of attribute summary.



4
5
6
 
# File 'lib/open_api/example.rb', line 4

def summary
  @summary
end

#value ⇒ Object

Returns the value of attribute value.



4
5
6
 
# File 'lib/open_api/example.rb', line 4

def value
  @value
end

Class Method Details

.load(hash) ⇒ Object 



13
14
15
16
17
18
19
20
21
22
 
# File 'lib/open_api/example.rb', line 13

def self.load(hash)
  return unless hash

  new(
    summary: hash["summary"]&.to_s,
    description: hash["description"]&.to_s,
    value: hash["value"],
    external_value: hash["externalValue"],
  )
end