controllers docs checkpoint

This commit is contained in:
Filip Izydorczyk
2021-01-16 13:57:58 +01:00
parent e600e84ae2
commit 9372ea5562
7 changed files with 137 additions and 14 deletions

View File

@ -27,6 +27,10 @@ import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
/**
* Rest controller to assignments related endpoints. More detailed api docs is
* available via swagger
*/
@RestController
@CrossOrigin
@RequestMapping("/api/" + App.API_VERSION + "/users")
@ -36,6 +40,10 @@ public class UsersController {
@Autowired
private UserService userService;
/**
* @param query to filrer userst with STUDENT role
* @return list found
*/
@GetMapping("/student/search")
@PreAuthorize("hasRole('ROLE_DEANERY')")
@ApiOperation(value = "Serch for user by providing query. If query is empty it will return all students. You need token with DEANERY role to call this")
@ -46,6 +54,9 @@ public class UsersController {
return new ResponseEntity<>(response, HttpStatus.OK);
}
/**
* @return list of all studnents
*/
@GetMapping("/students")
@PreAuthorize("hasRole('ROLE_DEANERY')")
@ApiOperation(value = "Gets all students. You need token with DEANERY role to call this")
@ -55,10 +66,16 @@ public class UsersController {
return new ResponseEntity<>(response, HttpStatus.OK);
}
/**
* @param authority USOS ID or E-mail. If user does not exist it should be USOS
* ID
* @return response entity was operation with succcesss
*/
@PostMapping(path = "/admin")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@ApiOperation(value = "Adds new admin user.")
public ResponseEntity<String> addAdmin(@RequestParam("authority") @ApiParam(value = "USOS ID or E-mail. If user does not exist it should be USOS ID") String authority) {
public ResponseEntity<String> addAdmin(
@RequestParam("authority") @ApiParam(value = "USOS ID or E-mail. If user does not exist it should be USOS ID") String authority) {
final Optional<User> userResponse = this.userService.getByAuthority(authority);
final User user = userResponse.orElseGet(() -> new User(null, null, null, authority, UserRoles.ADMIN));
user.setRole(UserRoles.ADMIN);
@ -66,10 +83,16 @@ public class UsersController {
return new ResponseEntity<>("Success", HttpStatus.OK);
}
/**
* @param authority USOS ID or E-mail. If user does not exist it should be USOS
* ID
* @return response entity was operation with succcesss
*/
@PostMapping(path = "/deanery")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@ApiOperation(value = "Adds new deanery user.")
public ResponseEntity<String> addDeanery(@RequestParam("authority") @ApiParam(value = "USOS ID or E-mail. If user does not exist it should be USOS ID") String authority) {
public ResponseEntity<String> addDeanery(
@RequestParam("authority") @ApiParam(value = "USOS ID or E-mail. If user does not exist it should be USOS ID") String authority) {
final Optional<User> userResponse = this.userService.getByAuthority(authority);
final User user = userResponse.orElseGet(() -> new User(null, null, null, authority, UserRoles.DEANERY));
user.setRole(UserRoles.DEANERY);