aarbit/scavengerhunt-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Adds descriptions to TeamController endpoints

Browse Source
This commit is contained in:
aarbit
2026-05-13 16:29:40 -05:00
parent 9324cf2eb0
commit 863c824421
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
src/main/kotlin/net/halfbinary/scavengerhuntapi/controller/TeamController.kt
View File

@@ -41,11 +41,13 @@ class TeamController(private val teamService: TeamService) {
} }
@GetMapping("/{teamId}") @GetMapping("/{teamId}")
@Operation(summary = "Get team info for the specified hunt")
fun getTeam(@PathVariable huntId: HuntId, @PathVariable teamId: TeamId): ResponseEntity<TeamResponse> { fun getTeam(@PathVariable huntId: HuntId, @PathVariable teamId: TeamId): ResponseEntity<TeamResponse> {
return ResponseEntity.ok(teamService.getTeamFromHunt(huntId, teamId).toResponse()) return ResponseEntity.ok(teamService.getTeamFromHunt(huntId, teamId).toResponse())
} }
@GetMapping("/{teamId}/item/{itemId}") @GetMapping("/{teamId}/item/{itemId}")
@Operation(summary = "Get found/not found status and photo information about the Item for the specified Team, Hunt, and Item")
fun getItemForTeam(@PathVariable huntId: HuntId, fun getItemForTeam(@PathVariable huntId: HuntId,
@PathVariable teamId: TeamId, @PathVariable teamId: TeamId,
@PathVariable itemId: ItemId): ResponseEntity<TeamItemResponse> { @PathVariable itemId: ItemId): ResponseEntity<TeamItemResponse> {
@@ -53,6 +55,7 @@ class TeamController(private val teamService: TeamService) {
} }
@GetMapping("/{teamId}/item/{itemId}/photo") @GetMapping("/{teamId}/item/{itemId}/photo")
@Operation(summary = "Get list of photo information for the specified Team, Hunt, and Item")
fun getItemPhotos(@PathVariable huntId: HuntId, fun getItemPhotos(@PathVariable huntId: HuntId,
@PathVariable teamId: TeamId, @PathVariable teamId: TeamId,
@PathVariable itemId: ItemId): ResponseEntity<List<PhotoResponse>> { @PathVariable itemId: ItemId): ResponseEntity<List<PhotoResponse>> {
@@ -60,6 +63,7 @@ class TeamController(private val teamService: TeamService) {
} }
@GetMapping("/{teamId}/item/{itemId}/photo/{photoId}") @GetMapping("/{teamId}/item/{itemId}/photo/{photoId}")
@Operation(summary = "Get photo information for the specified Team, Hunt, Item, and Photo")
fun getPhotoInfo(@PathVariable huntId: HuntId, fun getPhotoInfo(@PathVariable huntId: HuntId,
@PathVariable teamId: TeamId, @PathVariable teamId: TeamId,
@PathVariable itemId: ItemId, @PathVariable itemId: ItemId,
@@ -68,6 +72,7 @@ class TeamController(private val teamService: TeamService) {
} }
@GetMapping("/{teamId}/item/{itemId}/photo/{photoId}/file") @GetMapping("/{teamId}/item/{itemId}/photo/{photoId}/file")
@Operation(summary = "Get the binary image information for the specified Team, Hunt, Item, and Photo")
fun getPhoto(@PathVariable huntId: HuntId, fun getPhoto(@PathVariable huntId: HuntId,
@PathVariable teamId: TeamId, @PathVariable teamId: TeamId,
@PathVariable itemId: ItemId, @PathVariable itemId: ItemId,
@@ -76,6 +81,7 @@ class TeamController(private val teamService: TeamService) {
} }
@PostMapping("/{teamId}/item/{itemId}/photo") @PostMapping("/{teamId}/item/{itemId}/photo")
@Operation(summary = "Save photo information and store the binary file")
fun submitPhoto(@PathVariable huntId: HuntId, fun submitPhoto(@PathVariable huntId: HuntId,
@PathVariable teamId: TeamId, @PathVariable teamId: TeamId,
@PathVariable itemId: ItemId, @PathVariable itemId: ItemId,