Merge pull request #127 from AET-DevOps25/update-swagger

Update user ms swagger

Author: esadakcam

server/user/openapi.yml

@@ -3,37 +3,90 @@ info:
   title: OpenAPI definition
   version: v0
 servers:
-  - url: http://localhost:8081
-    description: Generated server url
+- url: http://localhost:8081
+  description: Generated server url
 tags:
-  - name: User Controller
-    description: Returns user information, requires bearer authorization
+- name: User Preferences Controller
+  description: "Handles user dietary preferences, requires bearer authorization"
+- name: User Controller
+  description: "Returns user information, requires bearer authorization"
 paths:
-  /info:
+  /user/preferences:
+    post:
+      tags:
+      - User Preferences Controller
+      operationId: saveUserPreferences
+      parameters:
+      - name: Authorization
+        in: header
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/SaveUserPreferencesRequestDto"
+        required: true
+      responses:
+        "200":
+          description: OK
+          content:
+            '*/*':
+              schema:
+                type: object
+  /user/info:
     get:
       tags:
-        - User Controller
+      - User Controller
       operationId: getUserInfo
       parameters:
-        - name: Authorization
-          in: header
-          required: true
-          schema:
-            type: string
+      - name: Authorization
+        in: header
+        required: true
+        schema:
+          type: string
       responses:
-        '200':
+        "200":
           description: OK
           content:
             '*/*':
               schema:
-                $ref: '#/components/schemas/User'
+                $ref: "#/components/schemas/User"
 components:
   schemas:
+    SaveUserPreferencesRequestDto:
+      type: object
+      properties:
+        dietaryPreferences:
+          uniqueItems: true
+          type: array
+          items:
+            type: string
+            enum:
+            - VEGETARIAN
+            - VEGAN
+            - GLUTEN_FREE
+            - DAIRY_FREE
+            - NUT_FREE
+            - SPICY_FOOD
     User:
       type: object
       properties:
+        username:
+          type: string
         id:
           type: integer
           format: int32
-        username:
-          type: string
+        dietaryPreferences:
+          uniqueItems: true
+          type: array
+          items:
+            type: string
+            enum:
+            - VEGETARIAN
+            - VEGAN
+            - GLUTEN_FREE
+            - DAIRY_FREE
+            - NUT_FREE
+            - SPICY_FOOD

server/user/src/main/java/com/continiousdisappointment/user/controller/UserPreferencesController.java

@@ -2,30 +2,31 @@
 
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
-import org.springframework.stereotype.Controller;
 import org.springframework.web.bind.annotation.PostMapping;
 import org.springframework.web.bind.annotation.RequestBody;
 import org.springframework.web.bind.annotation.RequestHeader;
 import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RestController;
 
 import com.continiousdisappointment.user.dto.SaveUserPreferencesRequestDto;
 import com.continiousdisappointment.user.service.UserService;
 
+import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 import lombok.extern.log4j.Log4j2;
 
-@Controller
+@RestController
 @RequestMapping("user/preferences")
 @Log4j2
 @RequiredArgsConstructor
+@Tag(name = "User Preferences Controller", description = "Handles user dietary preferences, requires bearer authorization")
 public class UserPreferencesController {
     private final UserService userService;
 
     @PostMapping
     public ResponseEntity<Object> saveUserPreferences(@RequestHeader("Authorization") String authorization,
             @RequestBody SaveUserPreferencesRequestDto request) {
         try {
-
             userService.saveUserPreferences(authorization, request.dietaryPreferences());
 
         } catch (Exception e) {