Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 932 Bytes

DEVDOC.md

File metadata and controls

51 lines (38 loc) · 932 Bytes
Raw

offTime REST API

To-do

  • v4 UUIDs
  • Image serving/uploading
  • websockets

design-doc

Features

REST Routes

  • GET /users
  • GET /users/{username}
  • PUT /users/{username}
  • PATCH /users/{username}
  • DELETE /users/{username}
  • PUT /users/{username}/picture
  • GET /users/{username}/usageHistory
  • POST /users/{username}/usageHistory
  • DELETE /users/{username}/usageHistory
  • GET /users/{username}/roomHistory
  • GET /rooms
  • GET /rooms/{roomID}

WebSocket events

  • createRoom
  • joinRoom
  • updateRoomUsage

CRUDs

  • GetAllUsers

  • GetUser

  • CreateUser

  • UpdateUser

  • DeleteUser

  • GetAllUsageHistoryOfUser

  • CreateUsageHistoryForUser

  • DeleteAllUsageHistoryForUser

  • GetAllRooms

  • GetRoom

  • CreateRoom

  • UpdateRoom

dev-log