chore: Various naming improvements

src/components/enums/repeat-unit.yaml

@@ -0,0 +1,17 @@
+description: The unit of how often to repeat
+type: integer
+format: u8
+default: once
+oneOf:
+  - title: once
+    const: 0
+    description: Never repeat (one off)
+  - title: days
+    const: 1
+    description: Repeat every day
+  - title: weeks
+    const: 2
+    description: Repeat every week
+  - title: months
+    const: 3
+    description: Repeat every month

src/components/examples/api/modules/{module}/history.yaml

@@ -8,14 +8,15 @@ data:
     ends: 54600
     lecturers:
       - 12
-    lecture_type: 0
+    lecture_series_type: 0
     rooms:
       - "4.417"
     pages:
       - 3
     dates: []
     course_pk: 1
-    module_execution_method: 0
+    lecture_execution_methods:
+      - 0
   - pk: 651
     name: oop1
     revision_pk: 16
@@ -25,11 +26,12 @@ data:
     ends: 42300
     lecturers:
       - 12
-    lecture_type: 0
+    lecture_series_type: 0
     rooms:
       - "4.427"
     pages:
       - 4
     dates: []
     course_pk: 1
-    module_execution_method: 0
+    lecture_execution_methods:
+      - 0

src/components/examples/api/terms/index.yaml

@@ -1,7 +1,7 @@
 data:
-  - term: 24HS
+  - name: 24HS
     start_date: 1728175749
     end_date: 1728375749
-  - term: 24FS
+  - name: 24FS
     start_date: 1728375750
     end_date: 1728575749

src/components/examples/api/terms/{term}/index.yaml

@@ -1,4 +1,4 @@
-term: 24FS
+name: 24FS
 start_date: 1728175749
 end_date: 1728375749
 revisions:

src/components/examples/api/terms/{term}/revisions/index.yaml

@@ -2,7 +2,7 @@ data:
   - name: prov_5
     changes: <p>Initialversion</p>
   - name: einschr_1
-    changes: >-
+    changes: |
       <p>Seit der letzten Version hat's neben diversen Raum- und
       Dozierenden-Änderungen folgende Anpassungen gegeben:</p>
 

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

@@ -1,4 +1,4 @@
-term: HS24
+term_pk: 1
 revision: einschr_3
 export_date: 17.06.2024 15:07:00
 parse_date: 04.10.2024 17:45:10

src/components/examples/api/terms/{term}/revisions/{revision}/lectures/index.yaml

@@ -10,8 +10,9 @@ data:
       - 5.3B51
     lecturers:
       - 14
-    lecture_type: 0
-    module_execution_method: 0
+    lecture_series_type: 0
+    lecture_execution_methods:
+      - 0
     pages:
       - 1
     course_pk: 2
@@ -28,8 +29,9 @@ data:
       - 5.3B51
     lecturers:
       - 10
-    lecture_type: 0
-    module_execution_method: 0
+    lecture_series_type: 0
+    lecture_execution_methods:
+      - 0
     pages:
       - 1
     course_pk: 2

src/components/examples/api/terms/{term}/revisions/{revision}/lectures/{lecture}/index.yaml

@@ -9,8 +9,9 @@ rooms:
   - 5.3B51
 lecturers:
   - 14
-lecture_type: 0
-module_execution_method: 0
+lecture_series_type: 0
+lecture_execution_methods:
+  - 0
 pages:
   - 1
 course_pk: 2

src/components/responses/api/me/events/index-get-200.yaml

@@ -7,7 +7,7 @@ content:
         data:
           type: array
           items:
-            $ref: ../../../../schemas/api/personal-event.yaml
+            $ref: ../../../../schemas/api/user-event.yaml
     # TODO
     # example:
     #   $ref: ../../../../examples/api/me/events.yaml

src/components/responses/api/me/events/index-post-200.yaml

@@ -2,7 +2,7 @@ description: OK
 content:
   application/json:
     schema:
-      $ref: ../../../../schemas/api/personal-event.yaml
+      $ref: ../../../../schemas/api/user-event.yaml
     # TODO
     # example:
     #   $ref: ../../../../examples/api/me/events.yaml

src/components/responses/api/me/events/{event}/index-get-200.yaml

@@ -2,7 +2,7 @@ description: OK
 content:
   application/json:
     schema:
-      $ref: ../../../../../schemas/api/personal-event.yaml
+      $ref: ../../../../../schemas/api/user-event.yaml
     # TODO
     # example:
     #   $ref: ../../../../../examples/api/me/events.yaml

src/components/responses/api/me/events/{event}/index-put-200.yaml

@@ -2,7 +2,7 @@ description: OK
 content:
   application/json:
     schema:
-      $ref: ../../../../../schemas/api/personal-event.yaml
+      $ref: ../../../../../schemas/api/user-event.yaml
     # TODO
     # example:
     #   $ref: ../../../../../examples/api/me/events.yaml

src/components/responses/api/me/index-get-200.yaml

@@ -2,7 +2,7 @@ description: OK
 content:
   application/json:
     schema:
-      $ref: ../../../schemas/api/me.yaml
+      $ref: ../../../schemas/api/user.yaml
     # TODO
     # example:
     #   $ref: ../../../examples/api/me/index.yaml

src/components/responses/api/me/plans/index-get-200.yaml

@@ -7,7 +7,7 @@ content:
         data:
           type: array
           items:
-            $ref: ../../../../schemas/api/plan.yaml
+            $ref: ../../../../schemas/api/user-plan.yaml
     # TODO
     # example:
     #   $ref: ../../../../examples/api/me/plans/index.yaml

src/components/responses/api/me/plans/index-post-200.yaml

@@ -4,7 +4,7 @@ content:
     schema:
       type: array
       items:
-        $ref: ../../../../schemas/api/plan.yaml
+        $ref: ../../../../schemas/api/user-plan.yaml
     # TODO
     # example:
     #   $ref: ../../../../examples/api/me/plans/index.yaml

src/components/responses/api/me/plans/{plan}/index-get-200.yaml

@@ -2,7 +2,7 @@ description: OK
 content:
   application/json:
     schema:
-      $ref: ../../../../../schemas/api/plan.yaml
+      $ref: ../../../../../schemas/api/user-plan.yaml
     # TODO
     # example:
     #   $ref: ../../../../../examples/api/me/plans/index.yaml

src/components/responses/api/me/plans/{plan}/index-put-200.yaml

@@ -2,7 +2,7 @@ description: OK
 content:
   application/json:
     schema:
-      $ref: ../../../../../schemas/api/plan.yaml
+      $ref: ../../../../../schemas/api/user-plan.yaml
     # TODO
     # example:
     #   $ref: ../../../../../examples/api/me/plans/index.yaml

src/components/schemas/api/lecture-series.yaml

@@ -33,10 +33,12 @@ properties:
     type: array
     items:
       $ref: ../relations/lecturer-pk.yaml
-  lecture_type:
-    $ref: ../../enums/teaching-type.yaml
-  module_execution_method:
-    $ref: ../../enums/lecture-execution-type.yaml
+  lecture_series_type:
+    $ref: ../../enums/lecture-series-type.yaml
+  lecture_execution_methods:
+    type: array
+    items:
+      $ref: ../../enums/lecture-execution-method.yaml
   pages:
     description: List of pages, on which the module can be found in the PDF
     type: array
@@ -53,6 +55,22 @@ properties:
     default: []
     items:
       type: string
+  start_date:
+    description: |
+      Date, when the lectures start. If null, the terms start and end dates apply.
+      Useful for block lecture series.
+    type:
+      - integer
+      - "null"
+    format: u64
+  end_date:
+    description: |
+      Date, when the lectures end. If null, the terms start and end dates apply. Useful
+      for block lecture series.
+    type:
+      - integer
+      - "null"
+    format: u64
   dates:
     description: |
       List of specific dates, when the lectures are held. This is used for
@@ -80,8 +98,6 @@ required:
   - ends
   - class
   - name
-  - rooms
-  - lecturers
-  - lecture_type
-  - module_execution_method
+  - lecture_series_type
+  - lecture_execution_methods
   - course_pk

src/components/schemas/api/term-revision-config.yaml

@@ -1,10 +1,8 @@
 type: object
 description: Revision specific configurations/additional information
 properties:
-  term:
-    description: Name of the term
-    type: string
-    example: HS24
+  term_pk:
+    $ref: ../relations/term-pk.yaml
   revision:
     description: Revision of the plan
     type: string
@@ -59,7 +57,7 @@ properties:
         - file_type
         - endpoint_type
 required:
-  - term
+  - term_pk
   - revision
   - export_date
   - parse_date

src/components/schemas/api/term-revisions-overview.yaml

@@ -3,7 +3,7 @@ description: Single term and all of its revisions
 properties:
   pk:
     $ref: ../common/pk.yaml
-  term:
+  name:
     description: Name of the term
     type: string
     example: "24HS"
@@ -16,6 +16,6 @@ properties:
     type: integer
     format: u64
 required:
-  - term
+  - name
   - start_date
   - end_date

src/components/schemas/api/term-revisions.yaml

@@ -3,7 +3,7 @@ description: Single term and all of its revisions
 properties:
   pk:
     $ref: ../common/pk.yaml
-  term:
+  name:
     description: Name of the term
     type: string
     example: "24HS"
@@ -21,7 +21,7 @@ properties:
     items:
       $ref: ./term-revision.yaml
 required:
-  - term
+  - name
   - start_date
   - end_date
   - revisions

src/components/schemas/api/term.yaml

@@ -3,7 +3,7 @@ description: Single term and all of its revisions
 properties:
   pk:
     $ref: ../common/pk.yaml
-  term:
+  name:
     description: Name of the term
     type: string
     example: "24HS"
@@ -16,6 +16,6 @@ properties:
     type: integer
     format: u64
 required:
-  - term
+  - name
   - start_date
   - end_date

src/components/schemas/api/personal-event.yaml → src/components/schemas/api/user-event.yaml

@@ -22,14 +22,18 @@ properties:
     default: null
   travel_time_before:
     description: How long we need to travel to get to our private event (in seconds)
-    type: integer
+    type:
+      - integer
+      - "null"
     format: u16
-    default: 0
+    default: null
   travel_time_after:
     description: How long we need to travel to get to back from our private event (in seconds)
-    type: integer
+    type:
+      - integer
+      - "null"
     format: u16
-    default: 0
+    default: null
   start_time:
     description: When the actual event starts (Unix timestamp in seconds)
     type: integer
@@ -44,18 +48,7 @@ properties:
     format: u8
     default: 0
   repeat_unit:
-    description: The unit of how often to repeat this event
-    type: string
-    default: once
-    oneOf:
-      - id: once
-        const: once
-      - id: days
-        const: days
-      - id: weeks
-        const: weeks
-      - id: months
-        const: months
+    $ref: ../../enums/repeat-unit.yaml
 required:
   - term_pk
   - title

src/components/schemas/api/me.yaml → src/components/schemas/api/user.yaml

@@ -15,7 +15,7 @@ properties:
   credited_modules:
     type: array
     items:
-      $ref: ./me-module.yaml
+      $ref: ./user-module.yaml
   gifted_credits:
     type: array
     items:
@@ -31,7 +31,7 @@ properties:
   enrolments:
     type: array
     items:
-      $ref: ./me-enrolment.yaml
+      $ref: ./user-enrolment.yaml
 required:
   - first_name
   - surname

src/paths/api/courses/index.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetCourses
-  summary: >-
+  summary: |
     A list of all courses
   security: []
   tags:
@@ -10,9 +10,9 @@ get:
       $ref: ../../../components/responses/api/courses/index-get-200.yaml
 post:
   operationId: PostCourse
-  summary: >-
+  summary: |
     Create a new course. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

src/paths/api/courses/{course}/index.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetCourse
-  summary: >-
+  summary: |
     Get a single course
   security: []
   parameters:
@@ -15,9 +15,9 @@ get:
 
 put:
   operationId: PutCourse
-  summary: >-
+  summary: |
     Update a course. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
@@ -42,9 +42,9 @@ put:
 
 delete:
   operationId: DeleteCourse
-  summary: >-
+  summary: |
     Delete a course. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

src/paths/api/lecturers/index.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetLecturers
-  summary: >-
+  summary: |
     A list of all the lecturers.
   security: []
   tags:
@@ -10,9 +10,9 @@ get:
       $ref: ../../../components/responses/api/lecturers/index-get-200.yaml
 post:
   operationId: PostLecturer
-  summary: >-
+  summary: |
     Create a new lecturer. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

src/paths/api/lecturers/{lecturer}/index.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetLecturer
-  summary: >-
+  summary: |
     Get a single lecturer
   security: []
   parameters:
@@ -15,9 +15,9 @@ get:
 
 put:
   operationId: PutLecturer
-  summary: >-
+  summary: |
     Update a lecturer. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
@@ -42,9 +42,9 @@ put:
 
 delete:
   operationId: DeleteLecturer
-  summary: >-
+  summary: |
     Delete a lecturer. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

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

@@ -1,8 +1,8 @@
 get:
   operationId: GetPersonalEvents
-  summary: >-
+  summary: |
     Get a list of personal events. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
@@ -18,9 +18,9 @@ get:
       $ref: ../../../../components/responses/404.yaml
 post:
   operationId: PostPersonalEvents
-  summary: >-
+  summary: |
     Create a new personal event. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
@@ -32,7 +32,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: "../../../../components/schemas/api/personal-event.yaml"
+          $ref: "../../../../components/schemas/api/user-event.yaml"
   responses:
     "200":
       $ref: ../../../../components/responses/api/me/events/index-post-200.yaml

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

@@ -1,14 +1,14 @@
 get:
   operationId: GetPersonalEvent
-  summary: >-
+  summary: |
     Get a single personal event. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
     - authRequired: []
   parameters:
-    - $ref: ../../../../../components/parameters/me-event.yaml
+    - $ref: ../../../../../components/parameters/user-event.yaml
   tags:
     - Me / Events
   responses:
@@ -21,15 +21,15 @@ get:
 
 put:
   operationId: PutPersonalEvent
-  summary: >-
+  summary: |
     Update a personal event. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
     - authRequired: []
   parameters:
-    - $ref: ../../../../../components/parameters/me-event.yaml
+    - $ref: ../../../../../components/parameters/user-event.yaml
   tags:
     - Me / Events
   requestBody:
@@ -37,7 +37,7 @@ put:
     content:
       application/json:
         schema:
-          $ref: "../../../../../components/schemas/api/personal-event.yaml"
+          $ref: "../../../../../components/schemas/api/user-event.yaml"
   responses:
     "200":
       $ref: ../../../../../components/responses/api/me/events/{event}/index-put-200.yaml
@@ -48,15 +48,15 @@ put:
 
 delete:
   operationId: DeletePersonalEvent
-  summary: >-
+  summary: |
     Delete a personal event. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
     - authRequired: []
   parameters:
-    - $ref: ../../../../../components/parameters/me-event.yaml
+    - $ref: ../../../../../components/parameters/user-event.yaml
   tags:
     - Me / Events
   responses:

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

@@ -1,8 +1,8 @@
 get:
   operationId: GetFavourites
-  summary: >-
+  summary: |
     Get a list of personal favourites. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
@@ -18,9 +18,9 @@ get:
       $ref: ../../../../components/responses/404.yaml
 post:
   operationId: PostFavourites
-  summary: >-
+  summary: |
     Create a new personal favourite. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

src/paths/api/me/favourites/{favourite}/index.yaml

@@ -1,14 +1,14 @@
 get:
   operationId: GetFavourite
-  summary: >-
+  summary: |
     Get a single personal favourite. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
     - authRequired: []
   parameters:
-    - $ref: ../../../../../components/parameters/me-favourite.yaml
+    - $ref: ../../../../../components/parameters/user-favourite.yaml
   tags:
     - Me / Favourites
   responses:
@@ -21,15 +21,15 @@ get:
 
 put:
   operationId: PutFavourite
-  summary: >-
+  summary: |
     Update a personal favourite. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
     - authRequired: []
   parameters:
-    - $ref: ../../../../../components/parameters/me-favourite.yaml
+    - $ref: ../../../../../components/parameters/user-favourite.yaml
   tags:
     - Me / Favourites
   requestBody:
@@ -48,15 +48,15 @@ put:
 
 delete:
   operationId: DeleteFavourite
-  summary: >-
+  summary: |
     Delete a personal favourite. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
     - authRequired: []
   parameters:
-    - $ref: ../../../../../components/parameters/me-favourite.yaml
+    - $ref: ../../../../../components/parameters/user-favourite.yaml
   tags:
     - Me / Favourites
   responses:

src/paths/api/me/index.yaml

@@ -1,8 +1,8 @@
 get:
   operationId: GetMe
-  summary: >-
+  summary: |
     Get information about myself. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

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

@@ -1,8 +1,8 @@
 get:
   operationId: GetPlans
-  summary: >-
+  summary: |
     Get a list of personal plans. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
@@ -18,9 +18,9 @@ get:
       $ref: ../../../../components/responses/404.yaml
 post:
   operationId: PostPlan
-  summary: >-
+  summary: |
     Create a new personal plan. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
@@ -32,7 +32,7 @@ post:
     content:
       application/json:
         schema:
-          $ref: "../../../../components/schemas/api/plan.yaml"
+          $ref: "../../../../components/schemas/api/user-plan.yaml"
   responses:
     "200":
       $ref: ../../../../components/responses/api/me/plans/index-post-200.yaml

src/paths/api/me/plans/{plan}/index.yaml

@@ -1,14 +1,14 @@
 get:
   operationId: GetPlan
-  summary: >-
+  summary: |
     Get a single plan. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
     - authRequired: []
   parameters:
-    - $ref: ../../../../../components/parameters/me-plan.yaml
+    - $ref: ../../../../../components/parameters/user-plan.yaml
   tags:
     - Me / Plans
   responses:
@@ -21,15 +21,15 @@ get:
 
 put:
   operationId: PutPlan
-  summary: >-
+  summary: |
     Update a personal plan. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
     - authRequired: []
   parameters:
-    - $ref: ../../../../../components/parameters/me-plan.yaml
+    - $ref: ../../../../../components/parameters/user-plan.yaml
   tags:
     - Me / Plans
   requestBody:
@@ -37,7 +37,7 @@ put:
     content:
       application/json:
         schema:
-          $ref: "../../../../../components/schemas/api/plan.yaml"
+          $ref: "../../../../../components/schemas/api/user-plan.yaml"
   responses:
     "200":
       $ref: ../../../../../components/responses/api/me/plans/{plan}/index-put-200.yaml
@@ -48,15 +48,15 @@ put:
 
 delete:
   operationId: DeletePlan
-  summary: >-
+  summary: |
     Delete a personal plan. [OPTIONAL:Storage]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
     - authRequired: []
   parameters:
-    - $ref: ../../../../../components/parameters/me-plan.yaml
+    - $ref: ../../../../../components/parameters/user-plan.yaml
   tags:
     - Me / Plans
   responses:

src/paths/api/modules/index.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetModules
-  summary: >-
+  summary: |
     All available modules and additional information.
   security: []
   tags:
@@ -10,9 +10,9 @@ get:
       $ref: ../../../components/responses/api/modules/index-get-200.yaml
 post:
   operationId: PostModule
-  summary: >-
+  summary: |
     Create a new module. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

src/paths/api/modules/{module}/history.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetModuleHistory
-  summary: >-
+  summary: |
     History of a single module
   security: []
   parameters:

src/paths/api/modules/{module}/index.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetSingleModule
-  summary: >-
+  summary: |
     Get the information about a single module
   security: []
   parameters:
@@ -15,9 +15,9 @@ get:
 
 put:
   operationId: PutModule
-  summary: >-
+  summary: |
     Update a module. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
@@ -42,9 +42,9 @@ put:
 
 delete:
   operationId: DeleteModule
-  summary: >-
+  summary: |
     Delete a module. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

src/paths/api/terms/index.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetTerms
-  summary: >-
+  summary: |
     Get a list of all the terms stored on this server
   security: []
   tags:
@@ -11,9 +11,9 @@ get:
 
 post:
   operationId: PostTerm
-  summary: >-
+  summary: |
     Create a new term. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

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

@@ -1,6 +1,6 @@
 get:
   operationId: GetSingleTerm
-  summary: >-
+  summary: |
     Get the information of a single term
   security: []
   parameters:
@@ -15,9 +15,9 @@ get:
 
 put:
   operationId: PutTerm
-  summary: >-
+  summary: |
     Update a term. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
@@ -42,9 +42,9 @@ put:
 
 delete:
   operationId: DeleteTerm
-  summary: >-
+  summary: |
     Delete a term. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

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

@@ -1,6 +1,6 @@
 get:
   operationId: GetTermRevisions
-  summary: >-
+  summary: |
     A list of all changes between the revisions of this term.
   security: []
   parameters:
@@ -15,9 +15,9 @@ get:
 
 post:
   operationId: PostTermRevision
-  summary: >-
+  summary: |
     Create a new term. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

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

@@ -1,6 +1,6 @@
 get:
   operationId: GetTermRevisionAssets
-  summary: >-
+  summary: |
     Retrieve a list of all assets for a specific term/revision.
   security: []
   tags:
@@ -16,9 +16,9 @@ get:
 
 post:
   operationId: PostTermRevisionAsset
-  summary: >-
+  summary: |
     Upload a new asset for a specific term/revision. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

src/paths/api/terms/{term}/revisions/{revision}/assets/{asset}/file.yaml

@@ -1,8 +1,8 @@
 get:
   operationId: GetTermRevisionAssetFile
-  summary: >-
+  summary: |
     Download an asset for a specific term/revision.
-  description: >-
+  description: |
     The download should not be forced upon the user, but simply stream the file.
   security: []
   tags:
@@ -19,9 +19,9 @@ get:
 
 post:
   operationId: PostTermRevisionAssetFile
-  summary: >-
+  summary: |
     Upload an asset for a specific term/revision. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security: []

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

@@ -1,6 +1,6 @@
 get:
   operationId: GetTermRevisionAssetDownload
-  summary: >-
+  summary: |
     Get the asset information
   security: []
   tags:
@@ -17,9 +17,9 @@ get:
 
 put:
   operationId: PutTermRevisionAsset
-  summary: >-
+  summary: |
     Update an asset. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
@@ -46,9 +46,9 @@ put:
 
 delete:
   operationId: DeleteTermRevisionAsset
-  summary: >-
+  summary: |
     Delete an asset. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

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

@@ -1,6 +1,6 @@
 get:
   operationId: GetTermRevision
-  summary: >-
+  summary: |
     Configuration/additional information for this term/revision.
   security: []
   tags:
@@ -16,9 +16,9 @@ get:
 
 put:
   operationId: PutTermRevision
-  summary: >-
+  summary: |
     Update a terms revision. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
@@ -44,9 +44,9 @@ put:
 
 delete:
   operationId: DeleteTermRevision
-  summary: >-
+  summary: |
     Delete a term. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

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

@@ -1,6 +1,6 @@
 get:
   operationId: GetTermRevisionLectures
-  summary: >-
+  summary: |
     A list of all lectures for this term/revision.
   security: []
   tags:
@@ -16,9 +16,9 @@ get:
 
 post:
   operationId: PostTermRevisionLecture
-  summary: >-
+  summary: |
     Create a new terms revisions lecture. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

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

@@ -1,6 +1,6 @@
 get:
   operationId: GetTermRevisionLecture
-  summary: >-
+  summary: |
     Get s single terms revisions lecture
   security: []
   tags:
@@ -17,9 +17,9 @@ get:
 
 put:
   operationId: PutTermRevisionLecture
-  summary: >-
+  summary: |
     Update a terms revisions lecture. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:
@@ -46,9 +46,9 @@ put:
 
 delete:
   operationId: DeleteTermRevisionLecture
-  summary: >-
+  summary: |
     Delete a term. [OPTIONAL:Management]
-  description: >-
+  description: |
     **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
     requires a server running!
   security:

src/paths/assets/changelog.yaml

@@ -1,6 +1,6 @@
 get:
   operationId: GetChangelog
-  summary: >-
+  summary: |
     HTML Changelog of the modulplaner frontend
   security: []
   tags: