modulplaner-openapi-spec/src/components/schemas/api/module.yaml

type: object
description: A single module definition
properties:
  short:
    description: Short name of the module / its human readable ID.
    type: string
  name:
    description: Full name of the module
    type: string
  for_degrees:
    description: List of degrees, for which this module is meant.
    type:
      - array
      - "null"
    items:
      type: string
  module_pk:
    description: The unique module ID number.
    type:
      - number
      - "null"
  module_related_pk:
    description: TODO
    type:
      - array
      - "null"
    items:
      type: integer
      format: int32
  ects:
    description: The number of ECTS this module awards upon completion.
    type:
      - number
      - "null"
  marks:
    description: |
      The types of marks that this module involves (Final exam, continuous grading,
      project, …).
    type:
      - array
      - "null"
    items:
      $ref: ../../enums/grading-type.yaml
  cat:
    description: Category of module (Context, Specialization, basic education, …).
    type:
      - string
      - "null"
  sub_cat:
    description: |
      Sub-category of the module (business administration, subject supplement,
      specialization).
    type:
      - string
      - "null"
  dependencies:
    description: |
      What dependencies are required to be able to participate in this module.
    $ref: ./module-dependency.yaml
  enabling_modules:
    description: |
      List of modules, that can be attended, after the completion of this module.
    $ref: ./module-dependency.yaml
required:
  - short
  - name
  - for_degrees
  - module_pk
  - module_related_pk
  - ects
  - marks
  - cat
  - sub_cat
  - dependencies
  - enabling_modules