add read category endpoint

- add endpoint for reading unique question categories for frontend filter component
- update api documentation

Author: feliciagan

backend/question-service/src/controllers/questionController.ts

@@ -12,6 +12,8 @@ import {
   QN_RETRIEVED_MESSAGE,
   PAGE_LIMIT_REQUIRED_MESSAGE,
   PAGE_LIMIT_INCORRECT_FORMAT_MESSAGE,
+  CATEGORIES_NOT_FOUND_MESSAGE,
+  CATEGORIES_RETRIEVED_MESSAGE,
 } from "../utils/constants.ts";
 
 import { upload } from "../../config/multer";
@@ -136,7 +138,7 @@ export const deleteQuestion = async (
     const { id } = req.params;
     const currentQuestion = await Question.findById(id);
     if (!currentQuestion) {
-      res.status(400).json({ message: QN_NOT_FOUND_MESSAGE });
+      res.status(404).json({ message: QN_NOT_FOUND_MESSAGE });
       return;
     }
 
@@ -235,3 +237,22 @@ export const readQuestionIndiv = async (
     res.status(500).json({ message: SERVER_ERROR_MESSAGE, error });
   }
 };
+
+export const readCategories = async (
+  req: Request,
+  res: Response,
+): Promise<void> => {
+  try {
+    const uniqueCats = await Question.distinct("category");
+    if (!uniqueCats || uniqueCats.length == 0) {
+      res.status(404).json({ message: CATEGORIES_NOT_FOUND_MESSAGE });
+    }
+
+    res.status(200).json({
+      message: CATEGORIES_RETRIEVED_MESSAGE,
+      categories: uniqueCats,
+    });
+  } catch (error) {
+    res.status(500).json({ message: SERVER_ERROR_MESSAGE, error });
+  }
+};

backend/question-service/src/routes/questionRoutes.ts

@@ -6,6 +6,7 @@ import {
   updateQuestion,
   readQuestionsList,
   readQuestionIndiv,
+  readCategories,
 } from "../controllers/questionController.ts";
 
 const router = express.Router();
@@ -16,6 +17,8 @@ router.post("/questions/images", createImageLink);
 
 router.put("/questions/:id", updateQuestion);
 
+router.get("/questions/categories", readCategories);
+
 router.get("/questions", readQuestionsList);
 
 router.get("/questions/:id", readQuestionIndiv);

backend/question-service/src/utils/constants.ts

@@ -21,3 +21,8 @@ export const PAGE_LIMIT_REQUIRED_MESSAGE =
 
 export const PAGE_LIMIT_INCORRECT_FORMAT_MESSAGE =
   "Page number and question limit per page should be positive integers.";
+
+export const CATEGORIES_NOT_FOUND_MESSAGE = "No categories found.";
+
+export const CATEGORIES_RETRIEVED_MESSAGE =
+  "Categories retrieved successfully.";

backend/question-service/swagger.yml

@@ -58,7 +58,7 @@ definitions:
     properties:
       message:
         type: string
-        deescription: Message
+        description: Message
   ServerError:
     type: object
     properties:
@@ -124,6 +124,83 @@ paths:
             application/json:
               schema:
                 $ref: "#/definitions/ServerError"
+    get:
+      tags:
+        - questions
+      summary: Reads a list of questions
+      description: Reads a limited list of questions based on current page and question limit per page, taking into account search and filter conditions (if any).
+      parameters:
+        - in: query
+          name: page
+          type: integer
+          required: true
+          description: Page of questions to return
+        - in: query
+          name: qnLimit
+          type: integer
+          required: true
+          description: Limit on number of questions to return
+        - in: query
+          name: title
+          type: string
+          required: false
+          description: Question title search keywords
+        - in: query
+          name: complexities
+          schema:
+            oneOf:
+              - type: string
+              - type: array
+                items:
+                  type: string
+          required: false
+          description: Question complexity filters
+        - in: query
+          name: categories
+          schema:
+            oneOf:
+              - type: string
+              - type: array
+                items:
+                  type: string
+          required: false
+          description: Question category filters
+      responses:
+        200:
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: Message
+                  pages:
+                    type: integer
+                    description: Total number of pages of questions
+                  questions:
+                    type: array
+                    items:
+                      $ref: "#/definitions/Question"
+        400:
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: "#/definitions/Error"
+        404:
+          description: Question Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/definitions/Error"
+        500:
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/definitions/ServerError"
   /api/questions/{id}:
     put:
       tags:
@@ -155,8 +232,8 @@ paths:
                     description: Message
                   question:
                     $ref: "#/definitions/Question"
-        400:
-          description: Bad Request
+        404:
+          description: Question Not Found
           content:
             application/json:
               schema:
@@ -189,8 +266,78 @@ paths:
                   message:
                     type: string
                     description: Message
-        400:
-          description: Bad Request
+        404:
+          description: Question Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/definitions/Error"
+        500:
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/definitions/ServerError"
+    get:
+      tags:
+        - questions
+      summary: Reads a question
+      description: Reads a question
+      parameters:
+        - in: path
+          name: id
+          type: string
+          required: true
+          description: Question id
+      responses:
+        200: 
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: Message
+                  question:
+                    $ref: "#/definitions/Question"
+        404: 
+          description: Question Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/definitions/Error"
+        500:
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/definitions/ServerError"
+  /api/questions/categories:
+    get:
+      tags:
+        - questions
+      summary: Returns question categories
+      description: Returns list of unique question categories
+      responses:
+        200: 
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: Message
+                  categories:
+                    type: array
+                    items:
+                      type: string
+                    description: Categories
+        404:
+          description: Categories Not Found
           content:
             application/json:
               schema: