OpenAPI Specification for Modulplaner

Sean Blackburn 461c84e910 feat: Add /me endpoint 1 рік тому
.woodpecker a71d07b2fb chore: Use woodpecker instead of forgejo actions 1 рік тому
src 461c84e910 feat: Add /me endpoint 1 рік тому
.copier-answers.yml a71d07b2fb chore: Use woodpecker instead of forgejo actions 1 рік тому
.gitignore a71d07b2fb chore: Use woodpecker instead of forgejo actions 1 рік тому
.pre-commit-config.yaml 4cb29591df feat: initial version 1 рік тому
.releaserc.yaml ee8cff7dd6 ci: Auto replace version number in OpenAPI file 1 рік тому
LICENCE 4cb29591df feat: initial version 1 рік тому
README.md 461c84e910 feat: Add /me endpoint 1 рік тому
cspell.config.yaml cbfd96588a feat!: Restful design 1 рік тому
makefile 4cb29591df feat: initial version 1 рік тому

README.md

Modulplaner OpenAPI

OpenAPI documentation of the modulplaner API

Definitions

  • Module: A specific unit or component of a broader course of study. It focuses on a particular topic or subject area within a course. Modules are usually part of a larger framework, and a course will consist of multiple modules.
  • Course: Refers to the entire program of study leading to a degree. It encompasses multiple modules that are structured over the duration of the (bachelors) program.
  • Term: Refers to any academic period, but it is often associated with systems that divide the academic year into two or more periods.
  • Lecture: A single session, where the lecture of a Module is held.
  • Lecture Series: An entire series over a term of lectures (of a single class)
  • Class: A subset of students, that attend a Lecture.
  • Lecturer: The person teaching the students.
  • Student: The person, who should be learning about new stuff.

Do not use these terms

  • Semester: This term is too limiting compared to Term, as it always refers to 6 months. Some schools will use different lengths for their terms.
  • Degree: We should use the term Course, as the degree is what you receive when completing a Course.
  • Teacher: Use Lecturer instead, as this is the common term used by universities.