openapi: add classes

Author: veloii

astro.config.mjs

@@ -162,6 +162,10 @@ export default defineConfig({
               label: "[GET] List Homeworks",
               link: "/client-api/operations/list-homeworks",
             },
+            {
+              label: "[GET] List Classes",
+              link: "/client-api/operations/list-classes",
+            },
             {
               label: "[GET] List Lessons",
               link: "/client-api/operations/list-lessons",

openapi/clientapi.yaml

@@ -133,6 +133,31 @@ paths:
               schema:
                 $ref: "./schemas/_common/error_response.yaml"
 
+  /classes/{studentId}:
+    get:
+      operationId: list-classes
+      summary: List Classes
+      description: Lists the student's classes
+      parameters:
+        - name: studentId
+          in: path
+          required: true
+          schema:
+            type: integer
+      responses:
+        "200":
+          description: Array of lessons
+          content:
+            application/json:
+              schema:
+                $ref: "./schemas/class/list_response.yaml"
+        "401":
+          description: Unauthorized
+          content:
+            application/json:
+              schema:
+                $ref: "./schemas/_common/error_response.yaml"
+
   /timetable/{studentId}:
     get:
       operationId: list-lessons

openapi/schemas/class/class.yaml

@@ -0,0 +1,16 @@
+type: object
+properties:
+  id:
+    type: integer
+  name:
+    type: string
+  room:
+    type: string
+  subject:
+    type: string
+  teacher:
+    type: string
+  teachers:
+    type: array
+    items:
+      type: string

openapi/schemas/class/list_response.yaml

@@ -0,0 +1,11 @@
+type: object
+properties:
+  data:
+    type: array
+    items:
+      $ref: "./class.yaml"
+  meta:
+    type: array
+    items: {}
+  success:
+    type: integer

src/content/docs/coverage.mdx

@@ -5,7 +5,6 @@ description: Track our progress of documentating the ClassCharts API
 
 Track our progress of documentating the ClassCharts API.
 
-- [ ] Classes
 - [ ] Wellbeing
 - [ ] Report concern
 - [ ] Report absence
@@ -25,6 +24,7 @@ Track our progress of documentating the ClassCharts API.
   - [x] List Homeworks
   - [x] Mark as complete
   - [ ] Mark as seen
+- [x] Classes
 - [x] Activity
 - [x] Behaviour
 - [x] Parent Behaviour