Skip to content

goal.md

Latest commit

 

History

History
41 lines (33 loc) · 783 Bytes

goal.md

File metadata and controls

41 lines (33 loc) · 783 Bytes

The Goal API

v0

Requirement:

  • Set a streak goal
  • Get streak (community support : mean you can see others people goal if they accept it to be public)
  • Update streak
  • Remove streak

Basic Models:

Goal {
    id: int
    description: string
    isPrivate: bool
    streak: int (if marked as done then increase the streak count)
    created_at: DateTime
}

Endpoints:

  • [GET] goals Desc: return all public goals Response: List<Goal>

  • [GET] goal?id=goal_id Desc: return a goal Response: Goal

  • [GET] goals/me Desc: return user goals Response: List<Goal>

  • [POST] goals Desc: set a goal (if done requried to create the goal first then use its id to set) Request: {goal_id, user_token}

  • [DELETE] goals/unset Desc: un-seta goal Request: {goal_id, user_token}