usuario controller final

This commit is contained in:
xXpuma99Xx 2022-12-23 13:49:47 -06:00
parent c21edf9e97
commit 8ab7bcc215

View File

@ -40,19 +40,16 @@ export class UsuarioController {
@Serealize(MessageOutputDto) @Serealize(MessageOutputDto)
@Post('registrar') @Post('registrar')
@Recaptcha() @Recaptcha()
@ApiOperation({ @ApiOperation({ description: 'Registro de usuario.' })
description: 'Enpoint que realiza el registro de un usuario.',
})
@ApiBody({ @ApiBody({
description: description: 'Variables que necesita el endpoint.',
'Todas la variables a excepción de id_usuario son obligatorias.',
examples: { examples: {
ejemplo: { ejemplo: {
value: { value: {
id_institucion_carrera: 1, id_institucion_carrera: 1,
telefono: '', telefono: '',
correo: '',
usuario: '', usuario: '',
_rfc: '',
}, },
}, },
}, },
@ -69,19 +66,17 @@ export class UsuarioController {
@Serealize(MessageOutputDto) @Serealize(MessageOutputDto)
@Put() @Put()
@UseGuards(AuthGuard('jwt')) @UseGuards(AuthGuard('jwt'))
@ApiOperation({ @ApiOperation({ description: 'Actualizar información de un usuario.' })
description: 'Enpoint que actualiza la información de un usuario.',
})
@ApiBearerAuth('jwt') @ApiBearerAuth('jwt')
@ApiBody({ @ApiBody({
description: 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: { examples: {
ejemplo: { ejemplo: {
value: { value: {
id_usuario: 1, id_usuario: 1,
correo: '', _correo: '',
telefono: '', _telefono: '',
}, },
}, },
}, },
@ -96,12 +91,10 @@ export class UsuarioController {
@Serealize(MessageOutputDto) @Serealize(MessageOutputDto)
@Put('update-password') @Put('update-password')
@UseGuards(AuthGuard('jwt')) @UseGuards(AuthGuard('jwt'))
@ApiOperation({ @ApiOperation({ description: 'Reenviar password al usuario.' })
description: 'Enpoint que envía una nueva password al correo del usuario.',
})
@ApiBearerAuth('jwt') @ApiBearerAuth('jwt')
@ApiBody({ @ApiBody({
description: 'Es obligatorio enviar el campo id_usuario.', description: 'Variables que necesita el endpoint.',
examples: { ejemplo: { value: { id_usuario: 1 } } }, examples: { ejemplo: { value: { id_usuario: 1 } } },
}) })
passwordResset(@Request() req, @Body() body: UpdateUsuarioInputDto) { passwordResset(@Request() req, @Body() body: UpdateUsuarioInputDto) {
@ -114,9 +107,7 @@ export class UsuarioController {
@Serealize(UsuarioOutputDto) @Serealize(UsuarioOutputDto)
@Get('usuario') @Get('usuario')
@UseGuards(AuthGuard('jwt')) @UseGuards(AuthGuard('jwt'))
@ApiOperation({ @ApiOperation({ description: 'Información de un usuario.' })
description: 'Enpoint que retorna la información de un usuario.',
})
@ApiBearerAuth('jwt') @ApiBearerAuth('jwt')
@ApiQuery({ @ApiQuery({
description: 'El número de cuenta que se quiere buscar.', description: 'El número de cuenta que se quiere buscar.',
@ -135,17 +126,17 @@ export class UsuarioController {
@UseGuards(AuthGuard('jwt')) @UseGuards(AuthGuard('jwt'))
@ApiOperation({ @ApiOperation({
description: 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') @ApiBearerAuth('jwt')
@ApiQuery({ @ApiQuery({
description: 'Página en la que se encuentra el usuario.', description: 'Página en la que se encuentra el operador.',
name: 'pagina', name: 'pagina',
type: 'string', type: 'string',
}) })
@ApiQuery({ @ApiQuery({
description: 'Id de la institución que se quiere usar como filtro.', description: 'Todos los usuarios activos.',
name: 'id_institucion', name: 'activo',
type: 'string', type: 'string',
required: false, required: false,
}) })
@ -155,6 +146,12 @@ export class UsuarioController {
type: 'string', type: 'string',
required: false, required: false,
}) })
@ApiQuery({
description: 'Id de la institución que se quiere usar como filtro.',
name: 'id_institucion',
type: 'string',
required: false,
})
@ApiQuery({ @ApiQuery({
description: 'Id del tipo usuario que se quiere usar como filtro.', description: 'Id del tipo usuario que se quiere usar como filtro.',
name: 'id_tipo_usuario', name: 'id_tipo_usuario',
@ -167,6 +164,12 @@ export class UsuarioController {
type: 'string', type: 'string',
required: false, required: false,
}) })
@ApiQuery({
description: 'Todos los usuarios registrados.',
name: 'password',
type: 'string',
required: false,
})
@ApiQuery({ @ApiQuery({
description: 'Usuario que se quiere buscar.', description: 'Usuario que se quiere buscar.',
name: 'usuario', name: 'usuario',