Sha256: fb94d1cf7a1f76c79baab506c42972d046313dec870d5a3be17fa70645851636

Contents?: true

Size: 862 Bytes

Versions: 9

Compression:

Stored size: 862 Bytes

Contents

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

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
useless-doc-0.7.0 lib/useless/doc/core/resource.rb
useless-doc-0.6.5 lib/useless/doc/core/resource.rb
useless-doc-0.6.4 lib/useless/doc/core/resource.rb
useless-doc-0.6.3 lib/useless/doc/core/resource.rb
useless-doc-0.6.2 lib/useless/doc/core/resource.rb
useless-doc-0.6.1 lib/useless/doc/core/resource.rb
useless-doc-0.6.0 lib/useless/doc/core/resource.rb
useless-doc-0.5.0 lib/useless/doc/core/resource.rb
useless-doc-0.4.0 lib/useless/doc/core/resource.rb