#6: API (in & out)

Contents

1. Definitions
2. Motivation
3. Assumptions
4. Proposal
5. Implementation
6. Deliverables
7. Risks
8. Progress log
9. Participants

Proposed by

TFF

Proposal type

Architecture, Other

Assigned to release

• draft2gether 2.0 (Unreleased)

State

being-discussed

Definitions

!!! - a "must have" feature

!! - a requested feature

! - a less desired feature

? - desired feature, but can be discussed for smaller changes

?? - a feature open for discussion

??? - a feature fully open for discussion in behaviour, ui, architecture...

CF - Criticality Factor. It is the multiplier number for each feature, to be used when calculating penalties on deliverables, in case of bugs or delivery missing. The higher, the most critical the feature is.

Motivation

Assumptions

Proposal

• To have an API set of functions allowing usage of some D2G functionality on 3rd-party web services. Possible functionalities follow:
  
• Authenticated (or non) access to:
  
• title/summary/full view of a given user draft or list of all user's drafts - !!! CF 3
  
• basic stats of user's drafts (# of comments, amends, avg. rating...) - ?? CF 2
  
• results of a given List View - ??? CF 2
  
• retrieve summary and/or full text of posts of a given draft, with special filtering parameters (author, date, rating, by friends, by friends of friends) -  ? CF 3
  
• heatmap/heatbar view of a given draft - ??? CF 2
  
• enable readers of user's 3rd party blog to submit comments/amends to draft - !!! CF 1
  
• use API's to send calendar events to Meetup, Google calendar, Upcoming and/or others - ?? CF 1
• developers must get an API key in order to use the API, so it would be possible to track usage statistics - !!! CF 2
  

Implementation

Deliverables

API registration/configuration form

Risks

Progress log

Participants