Contents

module Useless
  module Doc
    class Response

      # Documentation for a response status for an API action.
      #
      # @!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.
      #
      class Status

        attr_reader :code, :description

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

Version data entries

4 entries across 4 versions & 1 rubygems

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