modulplaner-openapi-spec/src/openapi.yaml

openapi: 3.1.0
info:
  title: Modulplaner OpenAPI
  version: 1.0.0
  contact:
    email: sean@black-burn.ch
  description: >
    OpenAPI documentation of the modulplaner API
  license:
    name: MPL 2.0
    url: https://www.mozilla.org/en-US/MPL/2.0/

components:
  securitySchemes:
    authRequired:
      type: http
      scheme: bearer

servers:
  - url: http://localhost:8080
    description: localhost

paths:
  # Lecturers
  /api/lecturers:
    $ref: ./paths/api/lecturers/index.yaml

  # Modules
  /api/modules:
    $ref: ./paths/api/modules/index.yaml
  /api/modules/{module}:
    $ref: ./paths/api/modules/{module}/index.yaml
  /api/modules/{module}/history:
    $ref: ./paths/api/modules/{module}/history.yaml

  # Semesters / Versions
  /api/semesters:
    $ref: ./paths/api/semesters/index.yaml
  /api/semesters/{semester}:
    $ref: ./paths/api/semesters/{semester}/index.yaml
  /api/semesters/{semester}/versions:
    $ref: ./paths/api/semesters/{semester}/versions/index.yaml

  /api/semesters/{semester}/versions/{version}:
    $ref: ./paths/api/semesters/{semester}/versions/{version}/index.yaml
  /api/semesters/{semester}/versions/{version}/classes:
    $ref: ./paths/api/semesters/{semester}/versions/{version}/classes.yaml

  # Assets
  /assets/changelog:
    $ref: ./paths/assets/changelog.yaml
  /assets/semesters/{semester}/version/{version}/file/{file}:
    $ref: ./paths/assets/semesters/{semester}/versions/{version}/file.yaml

  # Me
  /me:
    $ref: ./paths/api/me/index.yaml

  /me/personal-events:
    $ref: ./paths/api/me/personal-events/index.yaml
  /me/personal-events/{event}:
    $ref: ./paths/api/me/personal-events/{event}/index.yaml

  /me/favourites:
    $ref: ./paths/api/me/favourites/index.yaml
  /me/favourites/{favourite}:
    $ref: ./paths/api/me/favourites/{favourite}/index.yaml

  # /me/plans:
  #   $ref: ./paths/api/me/plans.yaml