docs(be): update swagger.yaml to include forum question mock meta data

bounswe · Oct 21, 2024 · e65d8ec · e65d8ec
1 parent ecb6ccb
commit e65d8ec
Showing 1 changed file with 51 additions and 6 deletions.
diff --git a/backend/swagger.yaml b/backend/swagger.yaml
@@ -62,14 +62,35 @@ paths:
     get:
       operationId: forum-questions_list
       description: ''
-      parameters: []
+      parameters:
+      - name: page
+        in: query
+        description: A page number within the paginated result set.
+        required: false
+        type: integer
       responses:
         '200':
           description: ''
           schema:
-            type: array
-            items:
-              $ref: '#/definitions/ForumQuestion'
+            required:
+            - count
+            - results
+            type: object
+            properties:
+              count:
+                type: integer
+              next:
+                type: string
+                format: uri
+                x-nullable: true
+              previous:
+                type: string
+                format: uri
+                x-nullable: true
+              results:
+                type: array
+                items:
+                  $ref: '#/definitions/ForumQuestion'
       tags:
       - forum-questions
     post:
@@ -395,11 +416,35 @@ definitions:
           $ref: '#/definitions/Tag'
       author:
         $ref: '#/definitions/UserInfo'
-      date:
-        title: Date
+      created_at:
+        title: Created at
         type: string
         format: date-time
         readOnly: true
+      answers_count:
+        title: Answers count
+        type: string
+        readOnly: true
+      is_bookmarked:
+        title: Is bookmarked
+        type: string
+        readOnly: true
+      is_upvoted:
+        title: Is upvoted
+        type: string
+        readOnly: true
+      upvotes_count:
+        title: Upvotes count
+        type: string
+        readOnly: true
+      is_downvoted:
+        title: Is downvoted
+        type: string
+        readOnly: true
+      downvotes_count:
+        title: Downvotes count
+        type: string
+        readOnly: true
   WordDefinition:
     required:
     - id