feat: tutorials

Author: shubham-1806

docs/spec/CodeCharacter-API.yml

@@ -699,6 +699,7 @@ paths:
                     college: NITT
                     avatarId: 1
                     tutorialLevel: 2
+                    codeTutorialLevel: 3
                     tier: TIER1
                     isProfileComplete: true
                     isTutorialComplete: true
@@ -1588,6 +1589,73 @@ paths:
       description: Gets all statistics for the current user
     parameters: []
 
+  '/codetutorial/get/{codeTutorialNumber}':
+    get:
+      summary: Get tutorial by number
+      description: Get a single tutorial
+      operationId: getCodeTutorialByNumber
+      parameters:
+        - name: codeTutorialNumber
+          in: path
+          required: true
+          schema:
+            type: integer
+      responses:
+        200:
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/TutorialsGetRequest'
+        401:
+          description: Unauthorized
+        403:
+          description: Forbidden
+        404:
+          description: Not found
+      tags:
+        - Tutorials
+
+  /codetutorial/submit:
+    post:
+      summary: Match Execution for Tutorials
+      description: Match making for Tutorials
+      operationId: createCodeTutorialMatch
+      responses:
+        '201':
+          description: Created
+        '400':
+          description: Bad Request
+          headers: {}
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GenericError'
+              examples:
+                Example:
+                  value:
+                    message: Some field missing
+        '401':
+          description: Unauthorized
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/CodeTutorialMatchRequest'
+            examples:
+              CodeExample:
+                value:
+                  value: '#include<iostream>'
+                  language: CPP
+                  codeTutorialNumber: 2
+              MapExample:
+                value:
+                  value: '[[0,0,0]]'
+                  codeTutorialNumber: 6
+      tags:
+        - Tutorials
+
 components:
   schemas:
     UserMatchStats:
@@ -2060,6 +2128,9 @@ components:
         tutorialLevel:
           type: integer
           example: 1
+        codeTutorialLevel:
+          type: integer
+          example: 3
         tier:
           $ref: '#/components/schemas/TierType'
         isProfileComplete:
@@ -2077,6 +2148,7 @@ components:
         - college
         - avatarId
         - tutorialLevel
+        - codeTutorialLevel
         - isProfileComplete
         - isTutorialComplete
     UpdateCurrentUserProfile:
@@ -2296,6 +2368,29 @@ components:
         - destruction
         - coinsUsed
         - status
+    TutorialGame:
+      title: Game
+      type: object
+      description: Game model
+      properties:
+        id:
+          type: string
+          format: uuid
+          example: 123e4567-e89b-12d3-a456-426614174000
+        destruction:
+          type: number
+          example: 100
+        coinsUsed:
+          type: integer
+        logs:
+          type: string
+        status:
+          $ref: '#/components/schemas/GameStatus'
+      required:
+        - id
+        - destruction
+        - coinsUsed
+        - status
     GameLog:
       type: string
       description: Game log model
@@ -2351,6 +2446,45 @@ components:
       required:
         - user
         - stats
+    TutorialsGetRequest:
+      title: Get tutorials
+      description: Get the game tutorials
+      type: object
+      properties:
+        tutorialId:
+          type: integer
+          example: 1
+        tutorialName:
+          type: string
+          example: Tutorial for Spawning attacker
+        tutorialType:
+          $ref: '#/components/schemas/ChallengeType'
+        description:
+          type: string
+          example: Brief description of how the code works
+        tutorialCodes:
+          $ref: '#/components/schemas/TutorialCodeObject'
+      required:
+        - tutorialId
+        - tutorialName
+        - tutorialCodes
+
+    TutorialCodeObject:
+      title: Tutorial Code Object
+      description: The object containing the code for the tutorial
+      type: object
+      properties:
+        cpp:
+          type: string
+          example: This would have the cpp code for the tutorial
+        java:
+          type: string
+          example: This would have the java code for the tutorial
+        python:
+          type: string
+          example: This would have the python code for the tutorial
+        image:
+          type: string
 
     DailyChallengeGetRequest:
       title: Get daily challenge
@@ -2417,6 +2551,22 @@ components:
           $ref: '#/components/schemas/Language'
       required:
         - value
+    CodeTutorialMatchRequest:
+      title: CodeTutorialMatchRequest
+      description: Request Model for the tutorial mode
+      type: object
+      properties:
+        value:
+          type: string
+          example: '#include<iostream>'
+        language:
+          $ref: '#/components/schemas/Language'
+        codeTutorialNumber:
+          type: integer
+          nullable: false
+      required:
+        - value
+        - codeTutorialNumber
     GenericError:
       title: GenericError
       type: object

packages/client/.openapi-generator/FILES

@@ -10,6 +10,7 @@ src/apis/MatchApi.ts
 src/apis/NotificationApi.ts
 src/apis/PvpGameApi.ts
 src/apis/StatsApi.ts
+src/apis/TutorialsApi.ts
 src/apis/UserApi.ts
 src/apis/index.ts
 src/index.ts