Sha256: d605d47b8ca83bb43d8b08ec83176be3c0bddafee8d269412cb445cd004d18ff

Contents?: true

Size: 996 Bytes

Versions: 6

Compression:

Stored size: 996 Bytes

Contents

module Useless
  module Doc
    module Core

      # Documentation for an HTTP response.
      #
      # @!attribute [r] code
      #   @return [Integer] the HTTP status code of the response.
      #
      # @!attribute [r] description
      #   @return [String] a description of the rationale for
      #     the response.
      #
      # @!attribute [r] headers
      #   @return [Array<Header>] the significant headers of the response.
      #   @see Useless::Doc::Core::Header
      #
      # @!attribute [r] body
      #   @return [Body] the body of the response.
      #
      class Response
        attr_accessor :code, :description, :status, :headers, :body

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

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
useless-doc-0.3.1 lib/useless/doc/core/response.rb
useless-doc-0.3.0 lib/useless/doc/core/response.rb
useless-doc-0.2.3 lib/useless/doc/core/response.rb
useless-doc-0.2.2 lib/useless/doc/core/response.rb
useless-doc-0.2.1 lib/useless/doc/core/response.rb
useless-doc-0.2.0 lib/useless/doc/core/response.rb