Merge pull request #28 from guanquann/user-qns-docs

Update swagger docs

Author: ruiqi7

backend/question-service/swagger.yml

@@ -5,6 +5,12 @@ info:
   version: 1.0.0
 
 components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+
   schemas:
     Question:
       properties:
@@ -93,6 +99,8 @@ paths:
         - questions
       summary: Creates a question
       description: Creates a question
+      security:
+        - bearerAuth: []
       requestBody:
         required: true
         content:
@@ -134,11 +142,13 @@ paths:
           name: page
           type: integer
           required: true
+          default: 1
           description: Page of questions to return
         - in: query
           name: qnLimit
           type: integer
           required: true
+          default: 10
           description: Limit on number of questions to return
         - in: query
           name: title
@@ -201,6 +211,8 @@ paths:
         - questions
       summary: Updates a question
       description: Updates a question
+      security:
+        - bearerAuth: []
       parameters:
         - in: path
           name: id
@@ -242,6 +254,8 @@ paths:
       tags:
         - questions
       summary: Deletes a question
+      security:
+        - bearerAuth: []
       description: Deletes a question
       parameters:
         - in: path

backend/user-service/swagger.yml

@@ -37,6 +37,12 @@ definitions:
         required: true
 
 components:
+  securitySchemes:
+    bearerAuth:
+      type: http
+      scheme: bearer
+      bearerFormat: JWT
+
   schemas:
     User:
       properties:
@@ -148,6 +154,8 @@ paths:
       tags:
         - users
       summary: Get all users
+      security:
+        - bearerAuth: []
       responses:
         200:
           description: Successful Response
@@ -195,6 +203,8 @@ paths:
           required: true
           schema:
             type: string
+      security:
+        - bearerAuth: []
       requestBody:
         content:
           application/json:
@@ -251,12 +261,37 @@ paths:
       summary: Delete a user account
       tags:
         - users
+      security:
+        - bearerAuth: []
       parameters:
         - in: path
           name: id
           required: true
           schema:
             type: string
+      responses:
+        200:
+          description: Successful Response
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: Message
+        404:
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
+        500:
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/ErrorResponse"
   /api/auth/login:
     post:
       summary: Login
@@ -316,6 +351,8 @@ paths:
       summary: Verify token
       tags:
         - auth
+      security:
+        - bearerAuth: []
       requestBody:
         required: true
         content: