Skip to content

API endpoints to rotate, get and set a group of people or a single person in charge of the chores of a team.

License

Notifications You must be signed in to change notification settings

isabel22/chores-rotation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

15 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Chores Rotation

API endpoints to rotate, get and set a group of people or a single person in charge of the chores of a team.

Endpoints

  • /current-turn:
    • Returns the pair of names of people that are currently on call
  • /next-turn:
    • Sets the new pair of people that will be on call
    • Assigns the new pair of people to the Channels assigned in the environment variable CHANNELS
    • Returns their names
  • /new-team:
    • Creates a new team.
    • params:
      • name: String
  • /new_chore:
    • Creates a new chore.
    • params:
      • name: String
      • required_users: Integer
  • /new-user:
    • Creates a new user.
    • params:
      • email: String
      • name: String
      • team: String
  • /list-users:
    • Returns all the users and its team_id
      user.name user.team_id\n
      user.name user.team_id\n
    
  • /list-teams:
    • Returns all the team names
      team.name\n
      team.name\n
      team.name\n
    
  • /list-chores:
    • Returns all the chores names
      chore.name\n
      chore.name\n
      chore.name\n
    
  • /assign-chore:
    • Assigns a chore to a user
    • params:
      • chore: String
      • email: String

About

API endpoints to rotate, get and set a group of people or a single person in charge of the chores of a team.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published