diff --git a/src/main/java/hhn/labsw/bugageocaching/controller/Controller.java b/src/main/java/hhn/labsw/bugageocaching/controller/Controller.java index 5cbb663..612c5e7 100644 --- a/src/main/java/hhn/labsw/bugageocaching/controller/Controller.java +++ b/src/main/java/hhn/labsw/bugageocaching/controller/Controller.java @@ -551,9 +551,14 @@ public class Controller { } //--------- - + @ApiOperation(value = "Lets the user join a Team") + @ApiResponses(value = { + @ApiResponse(code = 404, message = "Database error"), + @ApiResponse(code = 401, message = "JWT Token expired"), + @ApiResponse(code = 400, message = "Something went wrong at verification") + }) @CrossOrigin(origins = "*", allowedHeaders = "*") // only for dev purpose - @RequestMapping("/api/joinTeam") + @RequestMapping(value = "/api/joinTeam", method = RequestMethod.PUT, produces = "application/json") @ResponseBody public ResponseEntity joinTeam(@RequestParam String token, @RequestParam String teamID) { @@ -613,8 +618,14 @@ public class Controller { return ResponseEntity.status(200).body(new Gson().toJson(team)); } + @ApiOperation(value = "Removes the user from the Team") + @ApiResponses(value = { + @ApiResponse(code = 404, message = "Database error"), + @ApiResponse(code = 401, message = "JWT Token expired"), + @ApiResponse(code = 400, message = "Something went wrong at verification") + }) @CrossOrigin(origins = "*", allowedHeaders = "*") // only for dev purpose - @RequestMapping("/api/leaveTeam") + @RequestMapping(value = "/api/leaveTeam", method = RequestMethod.PUT, produces = "application/json") @ResponseBody public ResponseEntity leaveTeam(@RequestParam String token) { @@ -673,8 +684,14 @@ public class Controller { return ResponseEntity.status(200).body("Ok"); } + @ApiOperation(value = "Sends a Team Invite to the invitedUserEmail from the User (token)") + @ApiResponses(value = { + @ApiResponse(code = 404, message = "Database error"), + @ApiResponse(code = 401, message = "JWT Token expired"), + @ApiResponse(code = 400, message = "Something went wrong at verification") + }) @CrossOrigin(origins = "http://localhost:8081") // only for dev purpose - @RequestMapping("/api/sendTeamInvite") + @RequestMapping(value = "/api/sendTeamInvite", method = RequestMethod.POST, produces = "application/json") @ResponseBody public ResponseEntity sendTeamInvite(@RequestParam String token, @RequestParam String invitedUserEmail) { @@ -735,8 +752,14 @@ public class Controller { return ResponseEntity.status(200).body("OK"); } + @ApiOperation(value = "Returns all User invites for a specific User") + @ApiResponses(value = { + @ApiResponse(code = 404, message = "Database error"), + @ApiResponse(code = 401, message = "JWT Token expired"), + @ApiResponse(code = 400, message = "Something went wrong at verification") + }) @CrossOrigin(origins = "http://localhost:8081") // only for dev purpose - @RequestMapping("/api/getMyTeamInvites") + @RequestMapping(value = "/api/getMyTeamInvites", method = RequestMethod.GET, produces = "application/json") @ResponseBody public ResponseEntity getMyTeamInvites(@RequestParam String token) { // verify user @@ -768,8 +791,14 @@ public class Controller { return ResponseEntity.status(200).body(new Gson().toJson(teamInvitesList)); } + @ApiOperation(value = "Removes a team invite from a user (called if a user declined a team invite)") + @ApiResponses(value = { + @ApiResponse(code = 404, message = "Database error"), + @ApiResponse(code = 401, message = "JWT Token expired"), + @ApiResponse(code = 400, message = "Something went wrong at verification") + }) @CrossOrigin(origins = "http://localhost:8081") // only for dev purpose - @RequestMapping("/api/deleteTeamInvite") + @RequestMapping(value = "/api/deleteTeamInvite", method = RequestMethod.DELETE, produces = "application/json") @ResponseBody public ResponseEntity deleteTeamInvite(@RequestParam String token, @RequestParam String teamInviteID) { @@ -794,8 +823,14 @@ public class Controller { return ResponseEntity.status(200).body("OK"); } + @ApiOperation(value = "Sets the team status") + @ApiResponses(value = { + @ApiResponse(code = 404, message = "Database error"), + @ApiResponse(code = 401, message = "JWT Token expired"), + @ApiResponse(code = 400, message = "Something went wrong at verification") + }) @CrossOrigin(origins = "http://localhost:8081") // only for dev purpose - @RequestMapping("/api/setTeamStatus") + @RequestMapping(value = "/api/setTeamStatus", method = RequestMethod.PUT, produces = "application/json") @ResponseBody public ResponseEntity setTeamStatus(@RequestParam String token, @RequestParam String teamStatus) { @@ -839,22 +874,36 @@ public class Controller { return ResponseEntity.status(200).body(new Gson().toJson(teamStatus)); } + @ApiOperation(value = "Returns a team by a name") + @ApiResponses(value = { + @ApiResponse(code = 404, message = "Database error"), + }) @CrossOrigin(origins = "http://localhost:8081") // only for dev purpose - @RequestMapping("/api/getTeam") + @RequestMapping(value = "/api/getTeam", method = RequestMethod.GET, produces = "application/json") public ResponseEntity getTeam(@RequestParam String name){ ResponseEntity responseEntity = FinderUtil.findTeamByName(name); return responseEntity; } + @ApiOperation(value = "Returns all teammembers by the team name") + @ApiResponses(value = { + @ApiResponse(code = 404, message = "Database error"), + }) @CrossOrigin(origins = "http://localhost:8081") // only for dev purpose - @RequestMapping("/api/getTeamMembers") + @RequestMapping(value = "/api/getTeamMembers", method = RequestMethod.GET, produces = "application/json") public ResponseEntity getTeamMembers(@RequestParam String name){ return FinderUtil.findTeammemberByTeamName(name); } + @ApiOperation(value = "Returns the station the user is currently at (for a specific cache)") + @ApiResponses(value = { + @ApiResponse(code = 404, message = "Database error"), + @ApiResponse(code = 401, message = "JWT Token expired"), + @ApiResponse(code = 400, message = "Something went wrong at verification") + }) @CrossOrigin(origins = "*", allowedHeaders = "*") // only for dev purpose - @RequestMapping("/api/getCurrentStation") + @RequestMapping(value = "/api/getCurrentStation", method = RequestMethod.GET, produces = "application/json") @ResponseBody public ResponseEntity getStationFromUserAndCache(@RequestParam String token, @RequestParam String cacheID){ @@ -891,8 +940,14 @@ public class Controller { return ResponseEntity.status(200).body(bearbeitetRepository.findByUserAndCache(user, cache)); } + @ApiOperation(value = "Returns the ranking place on the leaderboard for a specific user") + @ApiResponses(value = { + @ApiResponse(code = 404, message = "Database error"), + @ApiResponse(code = 401, message = "JWT Token expired"), + @ApiResponse(code = 400, message = "Something went wrong at verification") + }) @CrossOrigin(origins = "http://localhost:8081") // only for dev purpose - @RequestMapping("/api/getRankingPlace") + @RequestMapping(value = "/api/getRankingPlace", method = RequestMethod.GET, produces = "application/json") public ResponseEntity getRankingPlace(@RequestParam String token){ // verify user @@ -916,8 +971,14 @@ public class Controller { return ResponseEntity.status(200).body(userRepository.getRankingPlaceFromUser(user.getUsername())); } + @ApiOperation(value = "Test method (Changes its purpose often)") + @ApiResponses(value = { + @ApiResponse(code = 404, message = "Database error"), + @ApiResponse(code = 401, message = "JWT Token expired"), + @ApiResponse(code = 400, message = "Something went wrong at verification") + }) @CrossOrigin(origins = "*", allowedHeaders = "*") // only for dev purpose - @RequestMapping("/api/hello") + @RequestMapping(value = "/api/hello", method = RequestMethod.GET, produces = "application/json") public ResponseEntity hello(@RequestParam String name) { return ResponseEntity.status(200).body(userRepository.getRankingPlaceFromUser(name)); }