From 8ab7bcc215147abf171fb914bbfbfc5072123b86 Mon Sep 17 00:00:00 2001 From: xXpuma99Xx <51341582+xXpuma99Xx@users.noreply.github.com> Date: Fri, 23 Dec 2022 13:49:47 -0600 Subject: [PATCH] usuario controller final --- src/usuario/usuario.controller.ts | 49 ++++++++++++++++--------------- 1 file changed, 26 insertions(+), 23 deletions(-) diff --git a/src/usuario/usuario.controller.ts b/src/usuario/usuario.controller.ts index cd8a11e..67084cf 100644 --- a/src/usuario/usuario.controller.ts +++ b/src/usuario/usuario.controller.ts @@ -40,19 +40,16 @@ export class UsuarioController { @Serealize(MessageOutputDto) @Post('registrar') @Recaptcha() - @ApiOperation({ - description: 'Enpoint que realiza el registro de un usuario.', - }) + @ApiOperation({ description: 'Registro de usuario.' }) @ApiBody({ - description: - 'Todas la variables a excepción de id_usuario son obligatorias.', + description: 'Variables que necesita el endpoint.', examples: { ejemplo: { value: { id_institucion_carrera: 1, telefono: '', - correo: '', usuario: '', + _rfc: '', }, }, }, @@ -69,19 +66,17 @@ export class UsuarioController { @Serealize(MessageOutputDto) @Put() @UseGuards(AuthGuard('jwt')) - @ApiOperation({ - description: 'Enpoint que actualiza la información de un usuario.', - }) + @ApiOperation({ description: 'Actualizar información de un usuario.' }) @ApiBearerAuth('jwt') @ApiBody({ description: - 'Todas las variables a excepción de id_usuario son opcionales.', + 'Variables que necesita el endpoint. Las variables con "_" al inicio son opcionales.', examples: { ejemplo: { value: { id_usuario: 1, - correo: '', - telefono: '', + _correo: '', + _telefono: '', }, }, }, @@ -96,12 +91,10 @@ export class UsuarioController { @Serealize(MessageOutputDto) @Put('update-password') @UseGuards(AuthGuard('jwt')) - @ApiOperation({ - description: 'Enpoint que envía una nueva password al correo del usuario.', - }) + @ApiOperation({ description: 'Reenviar password al usuario.' }) @ApiBearerAuth('jwt') @ApiBody({ - description: 'Es obligatorio enviar el campo id_usuario.', + description: 'Variables que necesita el endpoint.', examples: { ejemplo: { value: { id_usuario: 1 } } }, }) passwordResset(@Request() req, @Body() body: UpdateUsuarioInputDto) { @@ -114,9 +107,7 @@ export class UsuarioController { @Serealize(UsuarioOutputDto) @Get('usuario') @UseGuards(AuthGuard('jwt')) - @ApiOperation({ - description: 'Enpoint que retorna la información de un usuario.', - }) + @ApiOperation({ description: 'Información de un usuario.' }) @ApiBearerAuth('jwt') @ApiQuery({ description: 'El número de cuenta que se quiere buscar.', @@ -135,17 +126,17 @@ export class UsuarioController { @UseGuards(AuthGuard('jwt')) @ApiOperation({ description: - 'Información de 25 usuarios dependiendo de la página en la que se encuentra el usuario y sus filtros.', + 'Información de 25 usuarios dependiendo de los filtros enviados.', }) @ApiBearerAuth('jwt') @ApiQuery({ - description: 'Página en la que se encuentra el usuario.', + description: 'Página en la que se encuentra el operador.', name: 'pagina', type: 'string', }) @ApiQuery({ - description: 'Id de la institución que se quiere usar como filtro.', - name: 'id_institucion', + description: 'Todos los usuarios activos.', + name: 'activo', type: 'string', required: false, }) @@ -155,6 +146,12 @@ export class UsuarioController { type: 'string', required: false, }) + @ApiQuery({ + description: 'Id de la institución que se quiere usar como filtro.', + name: 'id_institucion', + type: 'string', + required: false, + }) @ApiQuery({ description: 'Id del tipo usuario que se quiere usar como filtro.', name: 'id_tipo_usuario', @@ -167,6 +164,12 @@ export class UsuarioController { type: 'string', required: false, }) + @ApiQuery({ + description: 'Todos los usuarios registrados.', + name: 'password', + type: 'string', + required: false, + }) @ApiQuery({ description: 'Usuario que se quiere buscar.', name: 'usuario',