Class: CtdDocumentation::Detail

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/ctd_documentation/models/detail.rb

Overview

Detail Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(description = SKIP, title = SKIP) ⇒ Detail

Returns a new instance of Detail.



41
42
43
44
45
 
# File 'lib/ctd_documentation/models/detail.rb', line 41

def initialize(description = SKIP,
               title = SKIP)
  @description = description unless description == SKIP
  @title = title unless title == SKIP
end

Instance Attribute Details

#description ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


14
15
16
 
# File 'lib/ctd_documentation/models/detail.rb', line 14

def description
  @description
end

#title ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


18
19
20
 
# File 'lib/ctd_documentation/models/detail.rb', line 18

def title
  @title
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/ctd_documentation/models/detail.rb', line 48

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.

  description = hash.key?('description') ? hash['description'] : SKIP
  title = hash.key?('title') ? hash['title'] : SKIP

  # Create object from extracted values.

  Detail.new(description,
             title)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/ctd_documentation/models/detail.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['description'] = 'description'
  @_hash['title'] = 'title'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/ctd_documentation/models/detail.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/ctd_documentation/models/detail.rb', line 29

def self.optionals
  %w[
    description
    title
  ]
end