CenterForDigitalHumanities / TPEN-services

Services required by TPEN interfaces in order to interact with data
1 stars 0 forks source link

Initiate Page Entity Class #49

Open cubap opened 7 months ago

cubap commented 7 months ago

A module for a "Page" is needed for use by the other services. In TPEN, a Page is a container for Annotation Pages with an id that is ordered by a Project. The module should support the methods needed for the api services.

A snip from the relevant document includes:

Single Canvas as “page” with at least one Annotation Page layer with annotations

  • Membership reference to Manifest
  • Consider previous and next Page
  • Parameterize
    • Only text blob, ordered array of strings
    • Only image annotation as URL
    • Get parent/sibling/children/project
    • Embed referenced documents
    • Metadata only
    • HTML document The module should be created and importable, but all the methods can just stub out. Tests come first and can simply expect(methodName).toBeInstanceOf("Function").

The clip above is a GET but there is also update and delete things to include.