Class: Apia::Definition

Inherits:

Object

• Object
• Apia::Definition

Defined in:

lib/apia/definition.rb

Direct Known Subclasses

Apia::Definitions::API, Apia::Definitions::Argument, Apia::Definitions::ArgumentSet, Apia::Definitions::Authenticator, Apia::Definitions::Controller, Apia::Definitions::Endpoint, Apia::Definitions::Enum, Apia::Definitions::Error, Apia::Definitions::Field, Apia::Definitions::Object, Apia::Definitions::Polymorph, Apia::Definitions::Scalar, RouteGroup

Instance Attribute Summary

• #description ⇒ Object

  Returns the value of attribute description.

• #id ⇒ Object

  Returns the value of attribute id.

• #name ⇒ Object

  Returns the value of attribute name.

• #schema ⇒ Object

  Returns the value of attribute schema.

Instance Method Summary

• #initialize(id) ⇒ Definition constructor

  A new instance of Definition.

• #schema? ⇒ Boolean
• #setup ⇒ Object
• #validate(errors) ⇒ Object

Constructor Details

#initialize(id) ⇒ Definition

Returns a new instance of Definition.

# File 'lib/apia/definition.rb', line 11

def initialize(id)
  @id = id
  setup
end

Instance Attribute Details

#description ⇒ Object

Returns the value of attribute description.

# File 'lib/apia/definition.rb', line 8

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.

# File 'lib/apia/definition.rb', line 6

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.

# File 'lib/apia/definition.rb', line 7

def name
  @name
end

#schema ⇒ Object

Returns the value of attribute schema.

# File 'lib/apia/definition.rb', line 9

def schema
  @schema
end

Instance Method Details

#schema? ⇒ Boolean

Returns:

• (Boolean)

# File 'lib/apia/definition.rb', line 16

def schema?
  @schema != false
end

#setup ⇒ Object

# File 'lib/apia/definition.rb', line 23

def setup
end

#validate(errors) ⇒ Object

# File 'lib/apia/definition.rb', line 20

def validate(errors)
end