Method: Useless::Doc::Action#method

Defined in:
lib/useless/doc/action.rb,
lib/useless/doc/action.rb

#method ⇒ String (readonly)

Returns the action’s HTTP method.

See Also:



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/useless/doc/action.rb', line 23

class Action

  module Method
    GET     = 'GET'
    HEAD    = 'HEAD'
    POST    = 'POST'
    PUT     = 'PUT'
    PATCH   = 'PATCH'
    DELETE  = 'DELETE'
    TRACE   = 'TRACE'
    CONNECT = 'CONNECT'
  end

  attr_reader :description, :method, :authentication_required,
    :request, :response

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