RC-52: added description for SettingsController

makurohashami · Apr 13, 2024 · 37addae · 37addae
1 parent 89c7646
commit 37addae
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/main/java/com/kotyk/realtorconnect/controller/SettingsController.java b/src/main/java/com/kotyk/realtorconnect/controller/SettingsController.java
@@ -5,6 +5,7 @@
 import com.kotyk.realtorconnect.config.RealtorConfiguration;
 import com.kotyk.realtorconnect.config.UserConfiguration;
 import com.kotyk.realtorconnect.dto.apiresponse.ApiSuccess;
+import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
@@ -32,21 +33,25 @@ public class SettingsController {
     public final RealEstateConfiguration realEstateConfiguration;
 
     @GetMapping("/file")
+    @Operation(summary = "Get app file settings")
     public ResponseEntity<ApiSuccess<FileConfigurationDto>> getFileConfiguration() {
         return ok(toFileConfigurationDto(fileConfiguration));
     }
 
     @GetMapping("/user")
+    @Operation(summary = "Get app user settings")
     public ResponseEntity<ApiSuccess<UserConfiguration>> getUserConfiguration() {
         return ok(userConfiguration);
     }
 
     @GetMapping("/realtor")
+    @Operation(summary = "Get app realtor settings")
     public ResponseEntity<ApiSuccess<RealtorConfiguration>> getRealtorConfiguration() {
         return ok(realtorConfiguration);
     }
 
     @GetMapping("/real-estate")
+    @Operation(summary = "Get app real estate settings")
     public ResponseEntity<ApiSuccess<RealEstateConfiguration>> getRealEstateConfiguration() {
         return ok(realEstateConfiguration);
     }