From 0e1d13d69258effdf6d15272f5fc193d6311998c Mon Sep 17 00:00:00 2001
From: Wang Shiji <scglwsj@163.com>
Date: Thu, 26 Sep 2024 20:13:51 +0800
Subject: [PATCH] update quiz api document

---
 api/quiz_ms-quiz-openapi.yaml | 198 ++++++++++++++++++++++++++++++++++
 1 file changed, 198 insertions(+)

diff --git a/api/quiz_ms-quiz-openapi.yaml b/api/quiz_ms-quiz-openapi.yaml
index 9b37b2d..a444743 100644
--- a/api/quiz_ms-quiz-openapi.yaml
+++ b/api/quiz_ms-quiz-openapi.yaml
@@ -43,6 +43,179 @@ paths:
             '*/*':
               schema:
                 $ref: "#/components/schemas/QuizResponse"
+  /v1/quizzes/{id}:
+    get:
+      summary: "GET v1/quizzes/{id}"
+      operationId: "getQuiz"
+      parameters:
+        - name: "id"
+          in: "path"
+          required: true
+          schema:
+            type: "integer"
+            format: "int64"
+        - name: "pageNumber"
+          in: "query"
+          required: true
+          schema:
+            type: "integer"
+            format: "int32"
+        - name: "pageSize"
+          in: "query"
+          required: true
+          schema:
+            type: "integer"
+            format: "int32"
+        - name: "x-user-id"
+          in: "header"
+          required: true
+          schema:
+            type: "string"
+        - name: "x-user-email"
+          in: "header"
+          required: true
+          schema:
+            type: "string"
+        - name: "x-user-roles"
+          in: "header"
+          required: true
+          schema:
+            type: "string"
+      responses:
+        "200":
+          description: "OK"
+          content:
+            '*/*':
+              schema:
+                $ref: "#/components/schemas/QuizResponse"
+  /v1/quizzes/me/in-progress:
+    get:
+      summary: "GET v1/quizzes/me/in-progress"
+      operationId: "getInProgressQuiz"
+      parameters:
+        - name: "pageNumber"
+          in: "query"
+          required: true
+          schema:
+            type: "integer"
+            format: "int32"
+        - name: "pageSize"
+          in: "query"
+          required: true
+          schema:
+            type: "integer"
+            format: "int32"
+        - name: "x-user-id"
+          in: "header"
+          required: true
+          schema:
+            type: "string"
+        - name: "x-user-email"
+          in: "header"
+          required: true
+          schema:
+            type: "string"
+        - name: "x-user-roles"
+          in: "header"
+          required: true
+          schema:
+            type: "string"
+      responses:
+        "200":
+          description: "OK"
+          content:
+            '*/*':
+              schema:
+                $ref: "#/components/schemas/QuizResponse"
+  /v1/quizzes/me/completed:
+    get:
+      summary: "GET v1/quizzes/me/completed"
+      operationId: "getCompletedQuiz"
+      parameters:
+        - name: "pageNumber"
+          in: "query"
+          required: true
+          schema:
+            type: "integer"
+            format: "int32"
+        - name: "pageSize"
+          in: "query"
+          required: true
+          schema:
+            type: "integer"
+            format: "int32"
+        - name: "x-user-id"
+          in: "header"
+          required: true
+          schema:
+            type: "string"
+        - name: "x-user-email"
+          in: "header"
+          required: true
+          schema:
+            type: "string"
+        - name: "x-user-roles"
+          in: "header"
+          required: true
+          schema:
+            type: "string"
+      responses:
+        "200":
+          description: "OK"
+          content:
+            '*/*':
+              schema:
+                $ref: "#/components/schemas/SimpleQuizResponse"
+  /v1/quizzes/{id}/mcqs/{mcqId}/attempt:
+    put:
+      summary: "PUT v1/quizzes/{id}/mcqs/{mcqId}/attempt"
+      operationId: "updateAttempt"
+      parameters:
+        - name: "id"
+          in: "path"
+          required: true
+          schema:
+            type: "integer"
+            format: "int64"
+        - name: "mcqId"
+          in: "path"
+          required: true
+          schema:
+            type: "integer"
+            format: "int64"
+        - name: "x-user-id"
+          in: "header"
+          required: true
+          schema:
+            type: "string"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/QuizAttemptRequest"
+        required: true
+      responses:
+        "204":
+          description: "No Content"
+  /v1/quizzes/{id}/abandon:
+    patch:
+      summary: "PATCH v1/quizzes/{id}/abandon"
+      operationId: "abandonQuiz"
+      parameters:
+        - name: "id"
+          in: "path"
+          required: true
+          schema:
+            type: "integer"
+            format: "int64"
+        - name: "x-user-id"
+          in: "header"
+          required: true
+          schema:
+            type: "string"
+      responses:
+        "204":
+          description: "No Content"
 components:
   schemas:
     QuizRequest:
@@ -155,3 +328,28 @@ components:
         points:
           type: "integer"
           format: "int32"
+    SimpleQuizResponse:
+      type: "object"
+      properties:
+        id:
+          type: "integer"
+          format: "int64"
+        mcqs:
+          type: "array"
+          items:
+            $ref: "#/components/schemas/MCQResponse"
+        status:
+          type: "string"
+          enum:
+            - "IN_PROGRESS"
+            - "COMPLETED"
+            - "ABANDONED"
+        points:
+          type: "integer"
+          format: "int32"
+    QuizAttemptRequest:
+      type: "object"
+      properties:
+        attemptOption:
+          type: "integer"
+          format: "int32"