Class: Useless::Doc::Response::Status

Inherits:

Object

• Object
• Useless::Doc::Response::Status

Defined in:

lib/useless/doc/response/status.rb

Overview

Documentation for a response status for an API action.

Instance Attribute Summary

• #code ⇒ Integer readonly

  The HTTP status code of the response.

• #description ⇒ String readonly

  A description of the rationale for the response.

Instance Method Summary

• #initialize(attrs = {}) ⇒ Status constructor

  A new instance of Status.

Constructor Details

#initialize(attrs = {}) ⇒ Status

# File 'lib/useless/doc/response/status.rb', line 20

def initialize(attrs = {})
  @code         = attrs[:code]
  @description  = attrs[:description]
end

Instance Attribute Details

#code ⇒ Integer (readonly)

# File 'lib/useless/doc/response/status.rb', line 14

class Status

  attr_reader :code, :description

  # @param [Hash] attrs corresponds to the class's instance attributes.
  #
  def initialize(attrs = {})
    @code         = attrs[:code]
    @description  = attrs[:description]
  end
end

#description ⇒ String (readonly)

# File 'lib/useless/doc/response/status.rb', line 14

class Status

  attr_reader :code, :description

  # @param [Hash] attrs corresponds to the class's instance attributes.
  #
  def initialize(attrs = {})
    @code         = attrs[:code]
    @description  = attrs[:description]
  end
end