Mod toggle responses.

Author: swoocn

src/config/docs/TogglesSchema.yml

@@ -61,26 +61,42 @@ components:
     AddToggleRs:
       type: object
       properties:
-        name:
-          type: string
-          example: testToggle
-        enabled:
-          type: boolean
-          example: false
-        description:
-          type: string
-          example: This is a toggle description.
+        addedToggle:
+          name:
+            type: string
+            example: testToggle
+          enabled:
+            type: boolean
+            example: false
+          description:
+            type: string
+            example: This is a toggle description.
 
     UpdateToggleRs:
       type: object
       properties:
-        name:
-          type: string
-          example: testToggle
-        enabled:
-          type: boolean
-          example: false
-        description:
-          type: string
-          example: This is a toggle description.
+        updatedToggle:
+          name:
+            type: string
+            example: testToggle
+          enabled:
+            type: boolean
+            example: false
+          description:
+            type: string
+            example: This is a toggle description.
+
+    DeleteToggleRs:
+      type: object
+      properties:
+        deletedToggle:
+          name:
+            type: string
+            example: testToggle
+          enabled:
+            type: boolean
+            example: false
+          description:
+            type: string
+            example: This is a toggle description.
 

src/controllers/admin/toggleController.ts

@@ -36,7 +36,7 @@ export const addToggle = async (req: Request, res: Response) => {
   try {
     const newToggle = await toggleService.addToggle({ name, enabled, description } as IToggle);
     logger.info(`Successfully added toggle with identifier ${name}`);
-    return res.status(201).json(newToggle);
+    return res.status(201).json({ message: "Toggle successfully added", newToggle });
   } catch (error) {
     logger.error(`Failed to add toggle for identifier ${ name }:`, error);
     return res.status(500).json({ message: 'An error occurred while adding toggle; please try again later' });
@@ -48,7 +48,7 @@ export const updateToggle = async (req: Request, res: Response) => {
   try {
     const updatedToggle = await toggleService.updateToggle(name, enabled, description);
     logger.info(`Successfully updated toggle with identifier ${name}`);
-    return res.status(200).json(updatedToggle);
+    return res.status(200).json({ message: "Toggle successfully updated", updatedToggle });
   } catch (error) {
     logger.error(`Failed to update toggle for identifier ${ name }:`, error);
     return res.status(500).json({ message: 'An error occurred while updating toggle; please try again later' });
@@ -64,7 +64,7 @@ export const deleteToggle = async (req: Request, res: Response) => {
       return res.status(404).json({ message: "Toggle not found" });
     }
     logger.info(`Successfully deleted toggle with identifier ${toggle_name}`);
-    return res.status(200).json({ message: "Toggle successfully deleted" });
+    return res.status(200).json({ message: "Toggle successfully deleted", deletedToggle });
   } catch (error) {
     logger.error(`Failed to delete toggle for identifier ${ toggle_name }:`, error);
     return res.status(500).json({ message: 'An error occurred while deleting toggle; please try again later' });

src/routes/toggle.routes.ts

@@ -94,7 +94,13 @@ toggleRoutes.get("/:toggle_name", toggleController.getToggle);
  *         content:
  *           application/json:
  *             schema:
- *                $ref: '/api/docs/TogglesSchema.yml#/components/schemas/AddToggleRs'
+ *               type: object
+ *               properties:
+ *                 message:
+ *                   type: string
+ *                   example: "Toggle successfully added"
+ *                 addedToggle:
+ *                   $ref: '/api/docs/TogglesSchema.yml#/components/schemas/AddToggleRs'
  *       401:
  *         description: Unauthorized
  *       500:
@@ -123,7 +129,13 @@ toggleRoutes.post("/add", verifyAdminToken, toggleController.addToggle);
  *         content:
  *           application/json:
  *             schema:
- *                $ref: '/api/docs/TogglesSchema.yml#/components/schemas/UpdateToggleRs'
+ *               type: object
+ *               properties:
+ *                 message:
+ *                   type: string
+ *                   example: "Toggle successfully updated"
+ *                 updatedToggle:
+ *                   $ref: '/api/docs/TogglesSchema.yml#/components/schemas/UpdateToggleRs'
  *       401:
  *         description: Unauthorized
  *       500:
@@ -149,7 +161,17 @@ toggleRoutes.put("/update", verifyAdminToken, toggleController.updateToggle);
  *         description: The name of the toggle to delete
  *     responses:
  *       200:
- *         description: Successful response | Toggle successfully deleted
+ *         description: Successful response
+ *         content:
+ *           application/json:
+ *             schema:
+ *               type: object
+ *               properties:
+ *                 message:
+ *                   type: string
+ *                   example: "Toggle successfully deleted"
+ *                 deletedToggle:
+ *                   $ref: '/api/docs/TogglesSchema.yml#/components/schemas/DeleteToggleRs'
  *       404:
  *         description: Toggle not found
  *       401:

test/controllers/admin/toggleController.spec.ts

@@ -139,7 +139,10 @@ describe('toggleController', () => {
 
       expect(toggleService.addToggle).toHaveBeenCalledWith(req.body);
       expect(res.status).toHaveBeenCalledWith(201);
-      expect(res.json).toHaveBeenCalledWith(newToggle);
+      expect(res.json).toHaveBeenCalledWith({ 
+        message: 'Toggle successfully added',
+        newToggle: newToggle
+      });
     });
 
     it('should return appropriate [500] when adding toggle fails', async () => {
@@ -184,7 +187,10 @@ describe('toggleController', () => {
 
       expect(toggleService.updateToggle).toHaveBeenCalledWith('testToggle', false, 'Test toggle');
       expect(res.status).toHaveBeenCalledWith(200);
-      expect(res.json).toHaveBeenCalledWith(updatedToggle);
+      expect(res.json).toHaveBeenCalledWith({
+        message: 'Toggle successfully updated',
+        updatedToggle: updatedToggle 
+      });
     });
 
     it('should return appropriate [500] when updating toggle fails', async () => {
@@ -225,7 +231,10 @@ describe('toggleController', () => {
 
       expect(toggleService.deleteToggleByName).toHaveBeenCalledWith('testToggle');
       expect(res.status).toHaveBeenCalledWith(200);
-      expect(res.json).toHaveBeenCalledWith({ message: 'Toggle successfully deleted' });
+      expect(res.json).toHaveBeenCalledWith({ 
+        message: 'Toggle successfully deleted', 
+        deletedToggle 
+      });
     });
 
     it('should return appropriate [404] when the toggle is not found', async () => {