Adding documentation for the rest of crr/

src/models/climbing-route-rating/route_ratings/routeRatings.router.ts

@@ -6,6 +6,37 @@ import {verifyCaptcha} from '../common/VerifyCaptcha';
 
 export const routeRatingsRouter = express.Router();
 
+/**
+ * @swagger
+ * /crr/ratings/by/route/{id}:
+ *      get:
+ *          summary: Retrieve the rating for the given route
+ *          description: Returns the medium amount of stars that the route got
+ *          tags:
+ *              - climbing-route-rating
+ *          responses:
+ *              200:
+ *                  description: Success
+ *                  content:
+ *                      application/json:
+ *                          schema:
+ *                              type: object
+ *                              properties:
+ *                                  rating:
+ *                                      type: float
+ *                                      description: The median amount of stars
+ *                                      example: 4.5
+ *              500:
+ *                  description: A server error occurred. Please try again. If this issue persists, contact the admin.
+ *          parameters:
+ *              -   in: path
+ *                  name: id
+ *                  required: true
+ *                  description: The id of the route
+ *                  schema:
+ *                      type: string
+ *                  example: duck-score-guide
+ */
 routeRatingsRouter.get('/by/route/:id', async (req: Request, res: Response) => {
     try {
         let route_id = req.params.id;
@@ -24,6 +55,55 @@ routeRatingsRouter.get('/by/route/:id', async (req: Request, res: Response) => {
     }
 });
 
+/**
+ * @swagger
+ * /crr/ratings:
+ *      post:
+ *          summary: Create a new rating
+ *          description: Creates a new rating and returns the id of the created rating
+ *          tags:
+ *              - climbing-route-rating
+ *          responses:
+ *              201:
+ *                  description: Created
+ *                  content:
+ *                      application/json:
+ *                          schema:
+ *                              type: object
+ *                              properties:
+ *                                  rating_id:
+ *                                      type: integer
+ *                                      description: The rating id
+ *                                      example: 1
+ *              400:
+ *                  description: Wrong parameters, see response body for detailed information
+ *              403:
+ *                  description: Invalid captcha, please try again.
+ *              500:
+ *                  description: A server error occurred. Please try again. If this issue persists, contact the admin.
+ *          parameters:
+ *              -   in: query
+ *                  name: route_id
+ *                  required: true
+ *                  description: The id of the route to create the rating for
+ *                  schema:
+ *                      type: string
+ *                  example: duck-score-guide
+ *              -   in: query
+ *                  name: stars
+ *                  required: true
+ *                  description: The amount of stars to give
+ *                  schema:
+ *                      type: integer
+ *                  example: 4
+ *              -   in: query
+ *                  name: h-captcha-response
+ *                  required: true
+ *                  description: The hCaptcha response key
+ *                  schema:
+ *                      type: string
+ *                  example: P0_ey[...]bVu
+ */
 routeRatingsRouter.post('/', async (req: Request, res: Response) => {
     try {
         let route_id = req.query.route_id as string;