Class: Harkness::Base::Summary

Inherits:

Shale::Mapper

• Object
• Shale::Mapper
• Harkness::Base::Summary

Defined in:

lib/harkness/models/base/summary.rb

Overview

Base class for the "summary" objects in an API response. These summary objects are linked objects to the main API response. For example, when retrieving a Character, one of the summary objects is a Series.

Direct Known Subclasses

CharacterSummary, ComicSummary, CreatorSummary, EventSummary, SeriesSummary, StorySummary

Instance Attribute Summary

• #name ⇒ String readonly

  The canonical name of the resource.

• #resourceURI ⇒ String readonly

  The path to the individual resource.

Instance Attribute Details

#name ⇒ String (readonly)

Returns the canonical name of the resource.

Returns:

• (String) —

  the canonical name of the resource.

# File 'lib/harkness/models/base/summary.rb', line 14

attribute :name, Shale::Type::String

#resourceURI ⇒ String (readonly)

Returns the path to the individual resource.

Returns:

• (String) —

  the path to the individual resource.

# File 'lib/harkness/models/base/summary.rb', line 11

attribute :resourceURI, Shale::Type::String