adding open api tags

hardikSinghBehl · Mar 6, 2024 · 3de10d4 · 3de10d4
1 parent 7955aea
commit 3de10d4
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/src/main/java/com/behl/overseer/controller/AuthenticationController.java b/src/main/java/com/behl/overseer/controller/AuthenticationController.java
@@ -19,12 +19,14 @@
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
 
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/api/v1")
+@Tag(name = "Authentication", description = "Endpoints for user account and authentication management")
 public class AuthenticationController {
 
 	private final UserService userService;

diff --git a/src/main/java/com/behl/overseer/controller/JokeController.java b/src/main/java/com/behl/overseer/controller/JokeController.java
@@ -15,11 +15,13 @@
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/api/v1")
+@Tag(name = "Joke Generator", description = "Endpoint for generating random unfunny joke")
 public class JokeController {
 
 	private final JokeGenerator jokeGenerator;

diff --git a/src/main/java/com/behl/overseer/controller/PlanController.java b/src/main/java/com/behl/overseer/controller/PlanController.java
@@ -22,12 +22,14 @@
 import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.responses.ApiResponse;
 import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
 
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/api/v1")
+@Tag(name = "Plan Management", description = "Endpoints for managing and retrieving available plan details")
 public class PlanController {
 
 	private final PlanService planService;