OpenAPI Specification for Modulplaner

Sean Blackburn 4cb29591df feat: initial version vor 1 Jahr
.forgejo 4cb29591df feat: initial version vor 1 Jahr
out 4cb29591df feat: initial version vor 1 Jahr
src 4cb29591df feat: initial version vor 1 Jahr
.copier-answers.yml 4cb29591df feat: initial version vor 1 Jahr
.gitignore 4cb29591df feat: initial version vor 1 Jahr
.pre-commit-config.yaml 4cb29591df feat: initial version vor 1 Jahr
.releaserc.yaml 4cb29591df feat: initial version vor 1 Jahr
LICENCE 4cb29591df feat: initial version vor 1 Jahr
README.md 4cb29591df feat: initial version vor 1 Jahr
cspell.config.yaml 4cb29591df feat: initial version vor 1 Jahr
makefile 4cb29591df feat: initial version vor 1 Jahr

README.md

Modulplaner OpenAPI

OpenAPI documentation of the modulplaner API

Improvements

  • Rename /data/ to /api/
  • Rename teachers to lecturers
  • Rename id fields to pk to avoid many naming collisions in programming languages
  • Move any binary files away from the API (xlsx, PDF, …)
  • The blockclasses should be part of the {version} api, not the {semester}
  • Change some German names to English (klassen.pdf, …)
  • Decide on Blockclass vs Blockmodule