Merge pull request #64 from Modarb-Ai-Trainer/swagger

src/modules/users/modules/auth/controllers/auth.controller.ts

@@ -15,6 +15,7 @@ import { UsersAuthService } from "../services/users-auth.service";
 import { SwaggerPost } from "@lib/decorators/swagger-routes.decorator";
 import { SwaggerRequest } from "@lib/decorators/swagger-request.decorator";
 import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
+import { SwaggerSummary } from "@lib/decorators/swagger-summary.decorator";
 
 @Controller("/user/auth")
 export class UsersAuthController extends BaseController {
@@ -36,6 +37,7 @@ export class UsersAuthController extends BaseController {
   @SwaggerPost("/register")
   @SwaggerRequest(userRegisterSchema)
   @SwaggerResponse(UserSerialization)
+  @SwaggerSummary("Register a new user")
   register = async (req: Request, res: Response) => {
     const user = await this.authService.register(req.body as IUserRegister);
 
@@ -50,6 +52,7 @@ export class UsersAuthController extends BaseController {
   @SwaggerPost("/login")
   @SwaggerRequest(loginValidationSchema)
   @SwaggerResponse(UserSerialization)
+  @SwaggerSummary("Login a user")
   login = async (req: Request, res: Response): Promise<Response> => {
     const { user, token } = await this.authService.login(req.body);
 

src/modules/users/modules/exercises/controllers/exercises.controller.ts

@@ -12,6 +12,7 @@ import { ControllerMiddleware } from "@lib/decorators/controller-middleware.deco
 import { UsersGuardMiddleware } from "modules/users/common/guards/users.guard";
 import { SwaggerGet } from "@lib/decorators/swagger-routes.decorator";
 import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
+import { SwaggerSummary } from "@lib/decorators/swagger-summary.decorator";
 
 @Controller("/user/exercises")
 @ControllerMiddleware(UsersGuardMiddleware())
@@ -26,6 +27,7 @@ export class ExerciseController extends BaseController {
 
   @SwaggerGet()
   @SwaggerResponse([ExerciseSerialization])
+  @SwaggerSummary("List all exercises for the user")
   list = async (req: Request, res: Response): Promise<Response> => {
     const paginationQuery = parsePaginationQuery(req.query);
     const { docs, paginationData } = await this.exercisesService.list(
@@ -44,6 +46,7 @@ export class ExerciseController extends BaseController {
 
   @SwaggerGet("/:id")
   @SwaggerResponse(ExerciseSerialization)
+  @SwaggerSummary("Get a single exercise")
   get = async (req: Request, res: Response): Promise<Response> => {
     const data = await this.exercisesService.findOneOrFail({
       _id: req.params.id,
@@ -59,6 +62,7 @@ export class ExerciseController extends BaseController {
 
   @SwaggerGet()
   @SwaggerResponse([ExerciseSerialization])
+  @SwaggerSummary("Search for exercises")
   search = async (req: Request, res: Response): Promise<Response> => {
     const paginationQuery = parsePaginationQuery(req.query);
     let query = {};

src/modules/users/modules/templates/controllers/templates.controller.ts

@@ -14,6 +14,7 @@ import {
   SwaggerGet,
   SwaggerPost,
 } from "@lib/decorators/swagger-routes.decorator";
+import { SwaggerSummary } from "@lib/decorators/swagger-summary.decorator";
 import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
 import { SwaggerRequest } from "@lib/decorators/swagger-request.decorator";
 import { createTemplatesSchema } from "../validations/create-templates.validation";
@@ -41,6 +42,7 @@ export class templateController extends BaseController {
 
   @SwaggerGet()
   @SwaggerResponse([TemplateSerialization])
+  @SwaggerSummary("List all templates for the user")
   list = async (req: userRequest, res: Response): Promise<Response> => {
     const paginationQuery = parsePaginationQuery(req.query);
     const { docs, paginationData } = await this.templatesService.list(
@@ -64,6 +66,7 @@ export class templateController extends BaseController {
 
   @SwaggerGet("/:id")
   @SwaggerResponse(TemplateSerialization)
+  @SwaggerSummary("Get a single template")
   get = async (req: userRequest, res: Response): Promise<Response> => {
     const data = await this.templatesService.findOneOrFail(
       {
@@ -87,6 +90,7 @@ export class templateController extends BaseController {
   @SwaggerPost()
   @SwaggerResponse(TemplateSerialization)
   @SwaggerRequest(createTemplatesSchema)
+  @SwaggerSummary("Create a new template plan")
   create = async (req: userRequest, res: Response) => {
     const data = await this.templatesService.create(req.body);
     return JsonResponse.success(

src/modules/users/modules/user-registered-workouts/controllers/user-registered-workouts.controller.ts

@@ -16,6 +16,8 @@ import {
   SwaggerGet,
   SwaggerPost,
 } from "@lib/decorators/swagger-routes.decorator";
+import { SwaggerSummary } from "@lib/decorators/swagger-summary.decorator";
+import { SwaggerDescription } from "@lib/decorators/swagger-description.decorator";
 import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
 import { SwaggerRequest } from "@lib/decorators/swagger-request.decorator";
 
@@ -45,6 +47,7 @@ export class userRegisteredWorkoutsController extends BaseController {
 
   @SwaggerGet()
   @SwaggerResponse([UserRegisteredWorkoutsSerialization])
+  @SwaggerDescription("List all user registered workouts (workouts that the user had started)")
   list = async (req: userRequest, res: Response) => {
     const paginationQuery = parsePaginationQuery(req.query);
     const { docs, paginationData } =
@@ -70,6 +73,7 @@ export class userRegisteredWorkoutsController extends BaseController {
 
   @SwaggerGet("/:id")
   @SwaggerResponse(UserRegisteredWorkoutsSerialization)
+  @SwaggerDescription("Get a single workout from user registered workouts (workouts that the user had started)")
   get = async (req: userRequest, res: Response) => {
     const data = await this.userRegisteredWorkoutsService.findOneOrFail(
       { _id: req.params.id },
@@ -90,6 +94,7 @@ export class userRegisteredWorkoutsController extends BaseController {
 
   @SwaggerGet("/home/:userId")
   @SwaggerResponse(UserRegisteredWorkoutsSerialization)
+  @SwaggerSummary("Get the home page for the user")
   getHomePage = async (req: userRequest, res: Response) => {
     const data = await this.userRegisteredWorkoutsService.findOneOrFail(
       { user: req.params.userId },
@@ -112,6 +117,7 @@ export class userRegisteredWorkoutsController extends BaseController {
   @SwaggerPost()
   @SwaggerResponse(UserRegisteredWorkoutsSerialization)
   @SwaggerRequest(createUserRegisteredWorkoutsSchema)
+  @SwaggerSummary("Create a workout for the user")
   create = async (req: userRequest, res: Response) => {
     const data = await this.userRegisteredWorkoutsService.create(req.body);
     return JsonResponse.success(

src/modules/users/modules/workouts/controllers/workouts.controller.ts

@@ -12,6 +12,8 @@ import { ControllerMiddleware } from "@lib/decorators/controller-middleware.deco
 import { UsersGuardMiddleware } from "modules/users/common/guards/users.guard";
 import { SwaggerGet } from "@lib/decorators/swagger-routes.decorator";
 import { SwaggerResponse } from "@lib/decorators/swagger-response.decorator";
+import { SwaggerSummary } from "@lib/decorators/swagger-summary.decorator";
+
 
 @Controller("/user/workouts")
 @ControllerMiddleware(UsersGuardMiddleware())
@@ -25,6 +27,7 @@ export class UsersWorkoutController extends BaseController {
 
   @SwaggerGet()
   @SwaggerResponse([WorkoutSerialization])
+  @SwaggerSummary("List all workouts for the user")
   list = async (req: Request, res: Response): Promise<Response> => {
     const paginationQuery = parsePaginationQuery(req.query);
     const { docs, paginationData } = await this.workoutsService.list(
@@ -43,6 +46,7 @@ export class UsersWorkoutController extends BaseController {
 
   @SwaggerGet("/:id")
   @SwaggerResponse(WorkoutSerialization)
+  @SwaggerSummary("Get a single workout")
   get = async (req: Request, res: Response): Promise<Response> => {
     const data = await this.workoutsService.findOneOrFail(
       { _id: req.params.id },