Adding documentation for the rest of crr/

2022-01-09 20:32:44 +01:00
parent 6f7069fdcb
commit 9aebd12d16
5 changed files with 329 additions and 1 deletions
@@ -34,30 +34,35 @@ export const raPlaMiddlewareRouter = express.Router();
 *                  description: The user from RaPla, can be taken directly from the RaPla link
 *                  schema:
 *                      type: string
+ *                  example: mueller
 *              -   in: query
 *                  name: file
 *                  required: true
 *                  description: The file from RaPla, can be taken directly from the RaPla link
 *                  schema:
 *                      type: string
+ *                  example: TINF19B4
 *              -   in: query
 *                  name: blockers
 *                  required: false
 *                  description: Whether to remove blockers from the .ics file
 *                  schema:
- *                      type: boolean [0,1]
+ *                      type: boolean
+ *                  example: 1
 *              -   in: query
 *                  name: wahl
 *                  required: false
 *                  description: The chosen elective module which is not to be filtered out
 *                  schema:
 *                      type: integer
+ *                  example: 0
 *              -   in: query
 *                  name: pflicht
 *                  required: false
 *                  description: The chosen profile module which is not to be filtered out
 *                  schema:
 *                      type: integer
+ *                  example: 2
 */
 raPlaMiddlewareRouter.get('/', async (req: Request, res: Response) => {
    try {