Class: Useless::Doc::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/useless/doc/request.rb,
lib/useless/doc/request/parameter.rb

Overview

Documentation for an HTTP request.

Defined Under Namespace

Classes: Parameter

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attrs = {}) ⇒ Request

Returns a new instance of Request.

Parameters:

  • attrs (Hash) (defaults to: {}) —

    corresponds to the class’s instance attributes.



22
23
24
25
26
 
# File 'lib/useless/doc/request.rb', line 22

def initialize(attrs = {})
  @parameters = attrs[:parameters]
  @headers    = attrs[:headers]
  @body       = attrs[:body]
end

Instance Attribute Details

#body ⇒ Body

Returns documentation for the body of the request.

Returns:

  • (Body) —

    documentation for the body of the request.



17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/useless/doc/request.rb', line 17

class Request
  attr_accessor :parameters, :headers, :body

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

#headers ⇒ Array<Header>

Returns documentation for the headers of the request.

Returns:

  • (Array<Header>) —

    documentation for the headers of the request.



17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/useless/doc/request.rb', line 17

class Request
  attr_accessor :parameters, :headers, :body

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

#parameters ⇒ Array<Request::Parameter] documentation for the parameters of the request.

Returns Array<Request::Parameter] documentation for the parameters of the request.

Returns:

  • (Array<Request::Parameter] documentation for the parameters of the request.) —

    Array<Request::Parameter] documentation for the parameters of the request.



17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/useless/doc/request.rb', line 17

class Request
  attr_accessor :parameters, :headers, :body

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