add tags to api endpoints (#192)

Closes #150 --------- Co-authored-by: Carson McManus <[email protected]>
dyc3 · May 2, 2023 · 66a38f0 · 66a38f0
1 parent d27fc09
commit 66a38f0
Showing 1 changed file with 20 additions and 1 deletion.
diff --git a/docs/api.yml b/docs/api.yml
@@ -16,6 +16,8 @@ paths:
   /api/user/register:
     summary: Register a new user
     post:
+      tags:
+        - user
       requestBody:
         content:
           application/json:
@@ -36,6 +38,8 @@ paths:
   /api/user/login:
     summary: Log in an existing user
     post:
+      tags:
+        - user
       requestBody:
         content:
           application/json:
@@ -56,6 +60,8 @@ paths:
   "/api/survey/create":
     post:
       summary: Create a new survey
+      tags:
+      - survey
       security:
         - JWT: []
       responses:
@@ -92,6 +98,8 @@ paths:
       - $ref: "#/components/parameters/survey"
     get:
       summary: Get a survey.
+      tags:
+        - survey
       description: >
         Get a survey. If the survey is not published, only the owner can
         get it. If the survey is published, anyone can get it.
@@ -136,6 +144,8 @@ paths:
           description: Survey not found
     patch:
       summary: Update a survey
+      tags:
+      - survey
       description: >
         Update a survey. Only the owner of the survey can update it. If the
         survey is published, it cannot be updated unless it is unpublished
@@ -181,6 +191,9 @@ paths:
   /api/user/surveys:
     summary: Get all surveys owned by the user
     get:
+      tags:
+        - survey
+        - user
       security:
         - JWT: []
       responses:
@@ -204,6 +217,8 @@ paths:
           format: uuid
     post:
       summary: Submit a survey response
+      tags:
+        - survey response
       description: >
         Submit a survey response. The request body is a JSON object with
         the question IDs as keys and the response as the value.
@@ -224,6 +239,8 @@ paths:
         $ref: "#/components/requestBodies/SurveyResponse"
     patch:
       summary: Update a survey response
+      tags:
+        - survey response
       description: >
         Update a survey response. The request body is a JSON object with
         the question IDs as keys and the response as the value.
@@ -239,6 +256,8 @@ paths:
         $ref: "#/components/requestBodies/SurveyResponse"
     get:
       summary: Get a survey response
+      tags:
+        - survey reponse
       parameters:
         - $ref: "#/components/parameters/ifmodifiedsince"
         - $ref: "#/components/parameters/ifnonematch"
@@ -445,4 +464,4 @@ components:
           type: array
           items:
             type: string
-            format: uuid
+            format: uuid