Contents

module Useless
  module Doc

    # Documentation for an HTTP request.
    #
    # @!attribute [r] parameters
    #   @return [Array<Request::Parameter] documentation for the parameters
    #     of the request.
    #
    # @!attribute [r] headers
    #   @return [Array<Header>] documentation for the headers of the
    #     request.
    #
    # @!attribute [r] body
    #   @return [Body] documentation for the body of the request.
    #
    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
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
useless-doc-0.1.3	lib/useless/doc/request.rb
useless-doc-0.1.2	lib/useless/doc/request.rb
useless-doc-0.1.1	lib/useless/doc/request.rb
useless-doc-0.1.0	lib/useless/doc/request.rb