{"openapi":"3.0.0","servers":[{"description":"SwaggerHub API Auto Mocking","url":"https://virtserver.swaggerhub.com/eksinyue/3219_otot_task_b/1.0.0"}],"info":{"description":"API documentation for OTOT Task B","version":"1.0.0","title":"3219 OTOT Task B","contact":{"email":"xinyuehe@u.nus.edu"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"tags":[{"name":"auth","description":"Authentication and Authorization"},{"name":"boards","description":"Board related API calls"},{"name":"messages","description":"Message related API calls"}],"paths":{"/auth/signup":{"post":{"tags":["auth"],"summary":"Create a new user","operationId":"userSignUp","description":"By passing in information on a new user, creates a new user and returns a jwt token.\n","responses":{"200":{"description":"Signup successfully","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}}}}}},"400":{"description":"Bad request"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewUser"}}},"description":"User to create"}}},"/auth/login":{"post":{"tags":["auth"],"summary":"Log in a user","operationId":"userLogin","description":"By passing in email and password of a user, returns a jwt token.\n","responses":{"200":{"description":"Login successfully","content":{"application/json":{"schema":{"type":"object","properties":{"token":{"type":"string"}}}}}},"400":{"description":"Bad request"},"401":{"description":"Wrong credentials"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserLogin"}}},"description":"User to create"}}},"/boards/all":{"get":{"tags":["boards"],"summary":"Gets all boards of a user","operationId":"getAllBoards","description":"Return all boards of an user.\n","security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Get boards succeeded","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Board"}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated"},"403":{"description":"Permission denied"}}}},"/boards/find/{boardId}":{"get":{"tags":["boards"],"summary":"Gets information on a board","operationId":"getBoardById","description":"By passing in a board id, return information on the board.\n","security":[{"bearerAuth":[]}],"parameters":[{"in":"path","required":true,"name":"boardId","description":"board's id","schema":{"type":"string","format":"uuid","example":"69b22b6e-c75f-40e2-b1f4-8c67b269d77c"}}],"responses":{"200":{"description":"search results matching criteria","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Board"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated"},"403":{"description":"Permission denied"}}}},"/boards/new":{"post":{"tags":["boards"],"summary":"Creates a new board","operationId":"createBoard","description":"By passing in information a new board, creates the new board.\n","security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Board created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Board"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated"},"403":{"description":"Permission denied"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewBoard"}}},"description":"Board to add"}}},"/boards/edit":{"put":{"tags":["boards"],"summary":"Edits a board","operationId":"editBoard","description":"By passing in new information a new board, updates the board.\n","security":[{"bearerAuth":[]}],"responses":{"201":{"description":"Board updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Board"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated"},"403":{"description":"Permission denied"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Board"}}},"description":"Board to add"}}},"/boards/{boardId}":{"delete":{"tags":["boards"],"summary":"Deletes a board","operationId":"deleteBoard","description":"By passing in a board id, delete the board.\n","security":[{"bearerAuth":[]}],"parameters":[{"in":"path","required":true,"name":"boardId","description":"board's id","schema":{"type":"string","format":"uuid","example":"69b22b6e-c75f-40e2-b1f4-8c67b269d77c"}}],"responses":{"200":{"description":"Successfully delete board","content":{"application/json":{"schema":{"type":"object","properties":{"boardId":{"type":"string","format":"uuid"}}}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthenticated"},"403":{"description":"Permission denied"}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}},"schemas":{"NewUser":{"type":"object","required":["username","email","password"],"properties":{"username":{"type":"string"},"email":{"type":"string","example":"hello@gmail.com"},"password":{"type":"string"}}},"UserLogin":{"type":"object","required":["email","password"],"properties":{"email":{"type":"string","example":"hello@gmail.com"},"password":{"type":"string"}}},"Board":{"type":"object","required":["boardId","userId","boardName"],"properties":{"boardId":{"type":"string","format":"uuid"},"isPublic":{"type":"boolean"},"boardUrl":{"type":"string"},"userId":{"type":"string","format":"uuid"},"messageVisibility":{"type":"boolean"},"boardName":{"type":"string"}}},"NewBoard":{"type":"object","required":["userId","boardName"],"properties":{"boardId":{"type":"string","format":"uuid"},"isPublic":{"type":"boolean"},"boardUrl":{"type":"string"},"userId":{"type":"string","format":"uuid"},"messageVisibility":{"type":"boolean"},"boardName":{"type":"string"}}}}}}