Class: DocSmoosher::ApiObject

Inherits:
Object
  • Object
show all
Includes:
Parameters
Defined in:
lib/doc_smoosher/api_object.rb

Direct Known Subclasses

Api, Field, Parameter, Request, Resource, Response

Instance Attribute Summary collapse

Attributes included from Parameters

#parameters, #resource

Instance Method Summary collapse

Methods included from Parameters

#parameter

Constructor Details

#initialize(params = {}, &block) ⇒ ApiObject

Returns a new instance of ApiObject.



7
8
9
10
11
12
13
# File 'lib/doc_smoosher/api_object.rb', line 7

def initialize(params = {}, &block)
  instance_eval(&block)

  params.each do |k,v|
    instance_variable_set("@#{k}", v) unless v.nil?
  end
end

Instance Attribute Details

#defaultObject

Returns the value of attribute default.



3
4
5
# File 'lib/doc_smoosher/api_object.rb', line 3

def default
  @default
end

#descriptionObject

Returns the value of attribute description.



3
4
5
# File 'lib/doc_smoosher/api_object.rb', line 3

def description
  @description
end

#exampleObject

Returns the value of attribute example.



3
4
5
# File 'lib/doc_smoosher/api_object.rb', line 3

def example
  @example
end

#nameObject

Returns the value of attribute name.



3
4
5
# File 'lib/doc_smoosher/api_object.rb', line 3

def name
  @name
end

#requiredObject

Returns the value of attribute required.



3
4
5
# File 'lib/doc_smoosher/api_object.rb', line 3

def required
  @required
end

#typeObject

Returns the value of attribute type.



3
4
5
# File 'lib/doc_smoosher/api_object.rb', line 3

def type
  @type
end