index.yaml 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. get:
  2. operationId: GetLecturer
  3. summary: |
  4. Get a single lecturer
  5. security: []
  6. parameters:
  7. - $ref: ../../../../components/parameters/lecturer.yaml
  8. tags:
  9. - Lecturers
  10. responses:
  11. "200":
  12. $ref: ../../../../components/responses/api/lecturers/{lecturer}/index-get-200.yaml
  13. "404":
  14. $ref: ../../../../components/responses/404.yaml
  15. put:
  16. operationId: PutLecturer
  17. summary: |
  18. Update a lecturer. [OPTIONAL:Management]
  19. description: |
  20. **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
  21. requires a server running!
  22. security:
  23. - authRequired: []
  24. parameters:
  25. - $ref: ../../../../components/parameters/lecturer.yaml
  26. tags:
  27. - Lecturers
  28. requestBody:
  29. required: true
  30. content:
  31. application/json:
  32. schema:
  33. $ref: "../../../../components/schemas/api/lecturer.yaml"
  34. responses:
  35. "200":
  36. $ref: ../../../../components/responses/api/lecturers/{lecturer}/index-put-200.yaml
  37. "401":
  38. $ref: ../../../../components/responses/401.yaml
  39. "404":
  40. $ref: ../../../../components/responses/404.yaml
  41. delete:
  42. operationId: DeleteLecturer
  43. summary: |
  44. Delete a lecturer. [OPTIONAL:Management]
  45. description: |
  46. **THIS IS AN OPTIONAL ENDPOINT**: This endpoint might not be implemented, as it
  47. requires a server running!
  48. security:
  49. - authRequired: []
  50. parameters:
  51. - $ref: ../../../../components/parameters/lecturer.yaml
  52. tags:
  53. - Lecturers
  54. responses:
  55. "204":
  56. $ref: ../../../../components/responses/204.yaml
  57. # TODO: What about dependencies?
  58. "401":
  59. $ref: ../../../../components/responses/401.yaml
  60. "404":
  61. $ref: ../../../../components/responses/404.yaml