Class: OpenApi::ExternalDocumentation

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

Overview

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, url:) ⇒ ExternalDocumentation

Returns a new instance of ExternalDocumentation.



6
7
8
9
 
# File 'lib/open_api/external_documentation.rb', line 6

def initialize(description: nil, url:)
  self.description = description
  self.url = url
end

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#url ⇒ Object

Returns the value of attribute url.



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

def url
  @url
end

Class Method Details

.load(hash) ⇒ Object 



11
12
13
14
15
16
17
18
 
# File 'lib/open_api/external_documentation.rb', line 11

def self.load(hash)
  return unless hash

  new(
    description: hash["description"]&.to_s,
    url: hash["url"].to_s,
  )
end