Skip to content

Architecture API

Sam Richard edited this page Aug 16, 2016 · 1 revision

API

The Holmes API will be for output only.

Requirements

  • Public API
    • All currently available public content
      • Public content means: Content on or past its sunrise date, before its sunset date, and considered publish-able as per workflow
        • This content would be considered "Published"
    • REST endpoint for individual pieces
    • Graph endpoint for all content in Graph relationship
    • Allow subscription that will send notifications of new updates
      • Includes published content going live
      • Includes published content going down
  • Private API
    • Separate port from public API
    • Requires authentication
    • Access for all sunrise/sunset/published/unpublished requests

TODO

  • Flesh out API requirements

Home

Working on Punchcard

Org Maintenance

Architecture Planning

These architectural discussions may be out-of-date given the current state of Punchcard.

Clone this wiki locally