chore: Add a short description to all tags

makefile

@@ -17,4 +17,4 @@ lint:
 
 preview-docs:
 	cd src; redocly bundle openapi.yaml -o ../out/openapi.json
-	docker run -p 8080:8080 -e SWAGGER_JSON=/out/openapi.json -v $(PWD)/out:/out swaggerapi/swagger-ui
+	docker run -p 8080:8080 -e SWAGGER_JSON=/out/openapi.json -e DOC_EXPANSION=none -v $(PWD)/out:/out swaggerapi/swagger-ui

src/openapi.yaml

@@ -20,6 +20,32 @@ servers:
   - url: http://localhost:8080
     description: localhost
 
+tags:
+  - name: Lecturers
+    description: Get details about the available lecturers
+  - name: Courses
+    description: Get details about the available courses / degree programs
+  - name: Modules
+    description: Get details about the modules and their past lecture series
+  - name: Terms
+    description: Get details about the terms / semesters
+  - name: Terms / Revisions
+    description: Get details about the terms / planning revisions
+  - name: Terms / Revisions / Lectures
+    description: Get the available lectures for a specific term / revision
+  - name: Terms / Revisions / Assets
+    description: Get the available assets for a specific term / revision
+  - name: Assets
+    description: Additional, global assets
+  - name: Me
+    description: Additional information about the currently logged in user
+  - name: Me / Events
+    description: Personal event by the currently logged in user
+  - name: Me / Favourites
+    description: Personal favourites by the currently logged in user
+  - name: Me / Plans
+    description: Personal plans by the currently logged in user
+
 paths:
   # Lecturers
   /api/lecturers:

src/paths/api/me/events/index.yaml

@@ -8,7 +8,7 @@ get:
   security:
     - authRequired: []
   tags:
-    - Me / Event
+    - Me / Events
   responses:
     "200":
       $ref: ../../../../components/responses/api/me/events/index-get-200.yaml
@@ -26,7 +26,7 @@ post:
   security:
     - authRequired: []
   tags:
-    - Me / Event
+    - Me / Events
   requestBody:
     required: true
     content:

src/paths/api/me/events/{event}/index.yaml

@@ -10,7 +10,7 @@ get:
   parameters:
     - $ref: ../../../../../components/parameters/me-event.yaml
   tags:
-    - Me / Event
+    - Me / Events
   responses:
     "200":
       $ref: ../../../../../components/responses/api/me/events/{event}/index-get-200.yaml
@@ -31,7 +31,7 @@ put:
   parameters:
     - $ref: ../../../../../components/parameters/me-event.yaml
   tags:
-    - Me / Event
+    - Me / Events
   requestBody:
     required: true
     content:
@@ -58,7 +58,7 @@ delete:
   parameters:
     - $ref: ../../../../../components/parameters/me-event.yaml
   tags:
-    - Me / Event
+    - Me / Events
   responses:
     "204":
       $ref: ../../../../../components/responses/204.yaml

src/paths/api/terms/{term}/revisions/index.yaml

@@ -6,7 +6,7 @@ get:
   parameters:
     - $ref: ../../../../../components/parameters/term.yaml
   tags:
-    - Terms / Revision
+    - Terms / Revisions
   responses:
     "200":
       $ref: ../../../../../components/responses/api/terms/{term}/revisions/index-get-200.yaml
@@ -25,7 +25,7 @@ post:
   parameters:
     - $ref: ../../../../../components/parameters/term.yaml
   tags:
-    - Terms / Revision
+    - Terms / Revisions
   requestBody:
     required: true
     content:

src/paths/api/terms/{term}/revisions/{revision}/index.yaml

@@ -4,7 +4,7 @@ get:
     Configuration/additional information for this term/revision.
   security: []
   tags:
-    - Terms / Revision
+    - Terms / Revisions
   parameters:
     - $ref: ../../../../../../components/parameters/term.yaml
     - $ref: ../../../../../../components/parameters/revision.yaml
@@ -27,7 +27,7 @@ put:
     - $ref: ../../../../../../components/parameters/term.yaml
     - $ref: ../../../../../../components/parameters/revision.yaml
   tags:
-    - Terms / Revision
+    - Terms / Revisions
   requestBody:
     required: true
     content:
@@ -55,7 +55,7 @@ delete:
     - $ref: ../../../../../../components/parameters/term.yaml
     - $ref: ../../../../../../components/parameters/revision.yaml
   tags:
-    - Terms / Revision
+    - Terms / Revisions
   responses:
     "204":
       $ref: ../../../../../../components/responses/204.yaml