{"swagger":"2.0","info":{"description":"7Quizzes Room controller API","version":"1.0.3","title":"7Quizzes Room controller API","contact":{"email":"dev-teachers@7bits.it"},"license":{"name":"Apache 2.0","url":"http://www.apache.org/licenses/LICENSE-2.0.html"}},"tags":[{"name":"User","description":"User requests"},{"name":"Room","description":"Room requests"},{"name":"Game","description":"Game requests"}],"paths":{"/signup":{"post":{"tags":["User"],"summary":"Sign up request","operationId":"signUp","description":"Sign up request","consumes":["application/json"],"parameters":[{"in":"body","name":"signUpRequest","description":"Sign up request body","schema":{"$ref":"#/definitions/signUpRequest"}}],"responses":{"200":{"description":"User signed up"},"400":{"description":"Invalid input, object invalid, user exists"}}}},"/signin":{"post":{"tags":["User"],"summary":"Sign in request","operationId":"signIn","description":"Sign in request","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"signInRequest","description":"Sign in request body","schema":{"$ref":"#/definitions/signInRequest"}}],"responses":{"200":{"description":"Successful sign in","schema":{"$ref":"#/definitions/signInResponse"}},"400":{"description":"Invalid input, object invalid"},"404":{"description":"Invalid login or password"}}}},"/users":{"get":{"tags":["User"],"summary":"Get user list","operationId":"getUsers","description":"Required authorities: ADMIN","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"header","name":"Authentication","required":true,"type":"string","description":"Bearer auth"}],"responses":{"200":{"description":"Successfully getting","schema":{"$ref":"#/definitions/getUsersResponse"}},"403":{"description":"User does not have access to the resource"}}}},"/users/{id}":{"parameters":[{"in":"path","name":"id","required":true,"type":"integer","minimum":1,"description":"The room id"}],"get":{"tags":["User"],"summary":"Get the user","operationId":"getUser","description":"Required authorities: ADMIN","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"header","name":"Authentication","required":true,"type":"string","description":"Bearer auth"}],"responses":{"200":{"description":"Successfully getting","schema":{"$ref":"#/definitions/getUserResponse"}},"403":{"description":"User does not have access to the resource"},"404":{"description":"The user not found"}}}},"/whoami":{"get":{"tags":["User"],"summary":"Get current user","operationId":"getCurrentUser","description":"Required authorities: USER","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"header","name":"Authentication","required":true,"type":"string","description":"Bearer auth"}],"responses":{"200":{"description":"Successfully getting","schema":{"$ref":"#/definitions/getUserResponse"}},"403":{"description":"User does not have access to the resource"}}}},"/rooms":{"get":{"tags":["Room"],"summary":"Get rooms","operationId":"getRooms","description":"Get all available rooms","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"header","name":"Authentication","required":true,"type":"string","description":"Bearer auth"}],"responses":{"200":{"description":"Successfully getting","schema":{"$ref":"#/definitions/getRoomsResponse"}}}},"post":{"tags":["Room"],"summary":"Allows to create room","operationId":"createRoom","description":"Allows to create room and join it","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"header","name":"Authentication","required":true,"type":"string","description":"Bearer auth"},{"in":"body","name":"createRoomRequest","description":"Create room request body","schema":{"$ref":"#/definitions/createRoomRequest"}}],"responses":{"200":{"description":"Successfully created and joined","schema":{"$ref":"#/definitions/createRoomResponse"}},"400":{"description":"Invalid input, object invalid"}}}},"/rooms/{id}":{"parameters":[{"in":"header","name":"Authentication","required":true,"type":"string","description":"Bearer auth"},{"in":"path","name":"id","required":true,"type":"integer","minimum":1,"description":"The room id"}],"get":{"tags":["Room"],"summary":"Get the room","operationId":"getRoom","description":"Get room","consumes":["application/json"],"produces":["application/json"],"responses":{"200":{"description":"Successfully got","schema":{"$ref":"#/definitions/getRoomResponse"}},"404":{"description":"Room with requested id was not found"}}},"post":{"tags":["Room"],"summary":"Allows to join room","operationId":"joinRoom","description":"Allows to join room","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"joinRoomRequest","description":"Join room request body","schema":{"$ref":"#/definitions/joinRoomRequest"}}],"responses":{"200":{"description":"Successfully joined"},"400":{"description":"Invalid input, object invalid"},"404":{"description":"Room with requested id was not found"}}}},"/rooms/{id}/game/start":{"parameters":[{"in":"header","name":"Authentication","required":true,"type":"string","description":"Bearer auth"},{"in":"path","name":"id","required":true,"type":"integer","minimum":1,"description":"The room id"}],"get":{"tags":["Game"],"summary":"Start the game","operationId":"startGame","description":"Allows to start the game and get first question","consumes":["application/json"],"produces":["application/json"],"responses":{"200":{"description":"Successfully started","schema":{"$ref":"#/definitions/startGameResponse"}},"404":{"description":"Invalid input, object invalid"}}}},"/rooms/{id}/game/{gameId}/answer":{"parameters":[{"in":"header","name":"Authentication","required":true,"type":"string","description":"Bearer auth"},{"in":"path","name":"id","required":true,"type":"string","minimum":1,"description":"The room id"},{"in":"path","name":"gameId","required":true,"type":"string","minimum":1,"description":"The game id"}],"post":{"tags":["Game"],"summary":"Answer the question","operationId":"answerQuestion","description":"Allows to answer the question by passing one of its options","consumes":["application/json"],"produces":["application/json"],"parameters":[{"in":"body","name":"answerQuestionRequest","description":"Answer question request body","schema":{"$ref":"#/definitions/answerQuestionRequest"}}],"responses":{"200":{"description":"Successfully answered","schema":{"$ref":"#/definitions/answerQuestionResponse"}},"404":{"description":"Room, answer, player or question with requested id was not found"}}}},"/rooms/{id}/game/{gameId}/next":{"parameters":[{"in":"header","name":"Authentication","required":true,"type":"string","description":"Bearer auth"},{"in":"path","name":"id","required":true,"type":"string","minimum":1,"description":"The room id"},{"in":"path","name":"gameId","required":true,"type":"string","minimum":1,"description":"The game id"}],"get":{"tags":["Game"],"summary":"Get next question","operationId":"getQuestion","description":"Allows to get next question","consumes":["application/json"],"produces":["application/json"],"responses":{"200":{"description":"Successfully got a question","schema":{"$ref":"#/definitions/questionWithOptions"}},"400":{"description":"Invalid input, object invalid"},"404":{"description":"Room with requested id was not found"}}}}},"definitions":{"signUpRequest":{"type":"object","properties":{"email":{"type":"string","format":"email","example":"username@gmail.com"},"password":{"type":"string","example":"w3GeUSKMk8*Nh7*G"}}},"signInRequest":{"type":"object","properties":{"email":{"type":"string","format":"email","example":"username@gmail.com"},"password":{"type":"string","example":"w3GeUSKMk8*Nh7*G"}}},"signInResponse":{"type":"object","properties":{"userToken":{"type":"string","format":"bearer token","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"}}},"getUsersResponse":{"type":"array","items":{"type":"object","properties":{"userId":{"type":"string","format":"uuid"},"username":{"type":"string","format":"uuid"},"authorities":{"type":"array","items":{"type":"string"}}}},"example":[{"userId":"0884831b-42f9-4f81-af88-3e777be69c8f","email":"admin@gmail.com","authorities":["USER","ADMIN"]}]},"getUserResponse":{"type":"object","properties":{"userId":{"type":"string","format":"uuid"},"username":{"type":"string","format":"uuid"},"authorities":{"type":"array","items":{"type":"string"}}},"example":{"userId":"0884831b-42f9-4f81-af88-3e777be69c8f","email":"admin@gmail.com","authorities":["USER","ADMIN"]}},"createRoomRequest":{"properties":{"playerId":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851"},"roomName":{"type":"string","example":"Room 1"}}},"joinRoomRequest":{"properties":{"playerId":{"type":"string","format":"uuid","example":"d290f1ee-6c54-4b01-90e6-d701748f0851"}}},"getRoomsResponse":{"type":"array","items":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"name":{"type":"string","format":"uuid"}}},"example":[{"roomId":"b8a71c88-7ae0-4a54-9697-9ceb5a1f8fc0","name":"Room 1"},{"roomId":"d8a71c88-7ae0-4a54-9697-9ceb5a1f8fc0","name":"Room 2"}]},"createRoomResponse":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"roomName":{"type":"string"},"players":{"type":"array","items":{"type":"object","properties":{"playerId":{"type":"string","format":"uuid"}}}}},"example":{"roomId":"b8a71c88-7ae0-4a54-9697-9ceb5a1f8fc0","roomName":"Room 1","players":[{"playerId":"d290f1ee-6c54-4b01-90e6-d701748f0851","playerScore":0}]}},"getRoomResponse":{"type":"object","properties":{"roomId":{"type":"string","format":"uuid"},"roomName":{"type":"string"},"players":{"type":"array","items":{"type":"object","properties":{"playerId":{"type":"string","format":"uuid"}}}}},"example":{"roomId":"b8a71c88-7ae0-4a54-9697-9ceb5a1f8fc0","roomName":"Room 1","players":[{"playerId":"f155326d-9d24-4a3a-b0b2-1ca7eb97b752"},{"playerId":"cd8522ee-bf02-4148-97b2-6c6af9825529"}]}},"startGameResponse":{"properties":{"gameId":{"type":"string","format":"uuid","example":"a293ce9c-13d1-4def-9f8a-d4f350b881c5"},"questionId":{"type":"string","format":"uuid"},"hasNext":{"type":"boolean"},"questionText":{"type":"string","example":"some-question-text"},"answersList":{"type":"array","items":{"$ref":"#/definitions/questionAnswer"}}}},"questionWithOptions":{"properties":{"questionId":{"type":"string","format":"uuid"},"hasNext":{"type":"boolean"},"questionText":{"type":"string","example":"some-question-text"},"answersList":{"type":"array","items":{"$ref":"#/definitions/questionAnswer"}}}},"answerQuestionRequest":{"type":"object","required":["playerId","questionId","answerId"],"properties":{"playerId":{"type":"string","format":"uuid","example":"f155326d-9d24-4a3a-b0b2-1ca7eb97b752"},"questionId":{"type":"string","format":"uuid","example":"949955a9-65fb-458e-9b6a-f60e406dc2df"},"answerId":{"type":"string","format":"uuid"}}},"answerQuestionResponse":{"type":"object","properties":{"correctAnswerId":{"type":"string","format":"uuid"},"totalScore":{"type":"object","properties":{"score":{"type":"integer","example":10}}},"questionScore":{"type":"object","properties":{"score":{"type":"integer","example":1}}}}},"questionAnswer":{"properties":{"answerId":{"type":"string","format":"uuid"},"answerText":{"type":"string","example":"some-answer-text"}}}},"basePath":"/7quizzes-team/7Quizzes/1.0.3","schemes":["https"],"host":"virtserver.swaggerhub.com"}