From ee3d890a8466e54aaa786ae584e3a7669f49a1f3 Mon Sep 17 00:00:00 2001 From: ScarletRedMan Date: Wed, 14 Feb 2024 23:24:12 +0700 Subject: [PATCH] Documented RoomPicker Info --- .../api/repository/response/RoomPickerInfoResponse.java | 7 ++++++- .../ru/dragonestia/picker/controller/RoomController.java | 1 - .../picker/controller/RoomPickerController.java | 4 ++++ 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/api/src/main/java/ru/dragonestia/picker/api/repository/response/RoomPickerInfoResponse.java b/api/src/main/java/ru/dragonestia/picker/api/repository/response/RoomPickerInfoResponse.java index d94394a..fce0956 100644 --- a/api/src/main/java/ru/dragonestia/picker/api/repository/response/RoomPickerInfoResponse.java +++ b/api/src/main/java/ru/dragonestia/picker/api/repository/response/RoomPickerInfoResponse.java @@ -1,3 +1,8 @@ package ru.dragonestia.picker.api.repository.response; -public record RoomPickerInfoResponse(String version) {} +import io.swagger.v3.oas.annotations.media.Schema; + +@Schema(title = "Server info", hidden = true) +public record RoomPickerInfoResponse( + @Schema(description = "RoomPicker server version", example = "0.0.1") String version +) {} diff --git a/app/src/main/java/ru/dragonestia/picker/controller/RoomController.java b/app/src/main/java/ru/dragonestia/picker/controller/RoomController.java index b3c26d7..fe4095c 100644 --- a/app/src/main/java/ru/dragonestia/picker/controller/RoomController.java +++ b/app/src/main/java/ru/dragonestia/picker/controller/RoomController.java @@ -6,7 +6,6 @@ import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.tags.Tag; import lombok.RequiredArgsConstructor; import org.springframework.http.ResponseEntity; -import org.springframework.security.core.parameters.P; import org.springframework.web.bind.annotation.*; import ru.dragonestia.picker.api.exception.NodeNotFoundException; import ru.dragonestia.picker.api.exception.RoomNotFoundException; diff --git a/app/src/main/java/ru/dragonestia/picker/controller/RoomPickerController.java b/app/src/main/java/ru/dragonestia/picker/controller/RoomPickerController.java index eefb0d6..496f4d3 100644 --- a/app/src/main/java/ru/dragonestia/picker/controller/RoomPickerController.java +++ b/app/src/main/java/ru/dragonestia/picker/controller/RoomPickerController.java @@ -1,12 +1,16 @@ package ru.dragonestia.picker.controller; +import io.swagger.v3.oas.annotations.Operation; +import io.swagger.v3.oas.annotations.tags.Tag; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; import ru.dragonestia.picker.api.repository.response.RoomPickerInfoResponse; +@Tag(name = "RoomPicker") @RestController public class RoomPickerController { + @Operation(summary = "Server info") @GetMapping("/info") RoomPickerInfoResponse info() { return new RoomPickerInfoResponse("v0.0.1");