cleanup swagger docs

This commit is contained in:
Lee 2024-04-10 11:09:09 +01:00
parent 78c3333038
commit c8c4c8ad3e
2 changed files with 9 additions and 18 deletions

@ -31,8 +31,7 @@ public class PlayerController {
@ResponseBody @ResponseBody
@GetMapping(value = "/{id}", produces = MediaType.APPLICATION_JSON_VALUE) @GetMapping(value = "/{id}", produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<?> getPlayer( public ResponseEntity<?> getPlayer(
@Parameter(description = "The UUID or Username of the player", example = "ImFascinated") @Parameter(description = "The UUID or Username of the player", example = "ImFascinated") @PathVariable String id) {
@PathVariable String id) {
return ResponseEntity.ok() return ResponseEntity.ok()
.cacheControl(cacheControl) .cacheControl(cacheControl)
.body(playerManagerService.getPlayer(id)); .body(playerManagerService.getPlayer(id));
@ -40,14 +39,10 @@ public class PlayerController {
@GetMapping(value = "/{part}/{id}") @GetMapping(value = "/{part}/{id}")
public ResponseEntity<?> getPlayerHead( public ResponseEntity<?> getPlayerHead(
@Parameter(description = "The part of the skin", example = "head") @Parameter(description = "The part of the skin", example = "head") @PathVariable String part,
@PathVariable String part, @Parameter(description = "The UUID or Username of the player", example = "ImFascinated") @PathVariable String id,
@Parameter(description = "The UUID or Username of the player", example = "ImFascinated") @Parameter(description = "The size of the image", example = "256") @RequestParam(required = false, defaultValue = "256") int size,
@PathVariable String id, @Parameter(description = "Whether to download the image") @RequestParam(required = false, defaultValue = "false") boolean download) {
@Parameter(description = "The size of the image", example = "256")
@RequestParam(required = false, defaultValue = "256") int size,
@Parameter(description = "Whether to download the image")
@RequestParam(required = false, defaultValue = "false") boolean download) {
Player player = playerManagerService.getPlayer(id); Player player = playerManagerService.getPlayer(id);
Skin.Parts skinPart = Skin.Parts.fromName(part); Skin.Parts skinPart = Skin.Parts.fromName(part);
String dispositionHeader = download ? "attachment; filename=%s.png" : "inline; filename=%s.png"; String dispositionHeader = download ? "attachment; filename=%s.png" : "inline; filename=%s.png";

@ -23,10 +23,8 @@ public class ServerController {
@ResponseBody @ResponseBody
@GetMapping(value = "/{platform}/{hostnameAndPort}", produces = MediaType.APPLICATION_JSON_VALUE) @GetMapping(value = "/{platform}/{hostnameAndPort}", produces = MediaType.APPLICATION_JSON_VALUE)
public CachedMinecraftServer getServer( public CachedMinecraftServer getServer(
@Parameter(description = "The platform of the server", example = "java") @Parameter(description = "The platform of the server", example = "java") @PathVariable String platform,
@PathVariable String platform, @Parameter(description = "The hostname and port of the server", example = "play.hypixel.net") @PathVariable String hostnameAndPort) {
@Parameter(description = "The hostname and port of the server", example = "play.hypixel.net")
@PathVariable String hostnameAndPort) {
Tuple<String, Integer> host = ServerUtils.getHostnameAndPort(hostnameAndPort); Tuple<String, Integer> host = ServerUtils.getHostnameAndPort(hostnameAndPort);
return serverService.getServer(platform, host.getLeft(), host.getRight()); return serverService.getServer(platform, host.getLeft(), host.getRight());
} }
@ -34,10 +32,8 @@ public class ServerController {
@ResponseBody @ResponseBody
@GetMapping(value = "/icon/{hostnameAndPort}", produces = MediaType.APPLICATION_JSON_VALUE) @GetMapping(value = "/icon/{hostnameAndPort}", produces = MediaType.APPLICATION_JSON_VALUE)
public ResponseEntity<?> getServerIcon( public ResponseEntity<?> getServerIcon(
@Parameter(description = "The hostname and port of the server", example = "play.hypixel.net") @Parameter(description = "The hostname and port of the server", example = "play.hypixel.net") @PathVariable String hostnameAndPort,
@PathVariable String hostnameAndPort, @Parameter(description = "Whether to download the image") @RequestParam(required = false, defaultValue = "false") boolean download) {
@Parameter(description = "Whether to download the image")
@RequestParam(required = false, defaultValue = "false") boolean download) {
Tuple<String, Integer> host = ServerUtils.getHostnameAndPort(hostnameAndPort); Tuple<String, Integer> host = ServerUtils.getHostnameAndPort(hostnameAndPort);
String hostname = host.getLeft(); String hostname = host.getLeft();
int port = host.getRight(); int port = host.getRight();