Class: Useless::Doc::Core::Request::Parameter

Inherits:

Object

• Object
• Useless::Doc::Core::Request::Parameter

Defined in:

lib/useless/doc/core/request.rb

Overview

Documentation for a request parameter for an API action.

Defined Under Namespace

Modules: Type

Instance Attribute Summary

• #default ⇒ String, Numeric readonly

  The value used if the parameter is omitted and is not required.

• #description ⇒ String readonly

  A description of the parameter.

• #key ⇒ String readonly

  The key of the parameter.

• #required ⇒ Boolean readonly

  Whether or not the parameter is required.

• #type ⇒ String readonly

  Either “path” if it’s part of the URL path, or “query” if it’s part of the query string.

Instance Method Summary

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

  A new instance of Parameter.

Constructor Details

#initialize(attrs = {}) ⇒ Parameter

# File 'lib/useless/doc/core/request.rb', line 95

def initialize(attrs = {})
  @type         = attrs[:type]
  @key          = attrs[:key]
  @required     = attrs[:required]
  @default      = attrs[:default]
  @description  = attrs[:description]
end

Instance Attribute Details

#default ⇒ String, Numeric (readonly)

# File 'lib/useless/doc/core/request.rb', line 84

class Parameter

  module Type
    PATH = 'path'
    QUERY = 'query'
  end

  attr_reader :type, :key, :required, :default, :description

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

#description ⇒ String (readonly)

# File 'lib/useless/doc/core/request.rb', line 84

class Parameter

  module Type
    PATH = 'path'
    QUERY = 'query'
  end

  attr_reader :type, :key, :required, :default, :description

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

#key ⇒ String (readonly)

# File 'lib/useless/doc/core/request.rb', line 84

class Parameter

  module Type
    PATH = 'path'
    QUERY = 'query'
  end

  attr_reader :type, :key, :required, :default, :description

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

#required ⇒ Boolean (readonly)

# File 'lib/useless/doc/core/request.rb', line 84

class Parameter

  module Type
    PATH = 'path'
    QUERY = 'query'
  end

  attr_reader :type, :key, :required, :default, :description

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

#type ⇒ String (readonly)

# File 'lib/useless/doc/core/request.rb', line 84

class Parameter

  module Type
    PATH = 'path'
    QUERY = 'query'
  end

  attr_reader :type, :key, :required, :default, :description

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