module Useless
  module Doc
    module Core

      # Documentation for an API resource.
      #
      # @!attribute [r] path
      #   @return [String] the path segment of the resource URL.
      #
      # @!attribute [r] description
      #   @return [String] a description of the resource.
      #
      # @!attribute [r] requests
      #   @return [Array<Request>] requests that could possibly be made
      #     against this resource.
      #   @see Useless::Doc::Core::Request
      #
      class Resource

        attr_reader :path, :description, :requests

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