From e3ca189aea3a9723d91ace197092794c399466d7 Mon Sep 17 00:00:00 2001
From: xXpuma99Xx <51341582+xXpuma99Xx@users.noreply.github.com>
Date: Mon, 30 May 2022 16:02:01 -0500
Subject: [PATCH] =?UTF-8?q?operador=20documentaci=C3=B3n?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../carrera-programa.controller.ts            | 20 +++---
 src/carrito/carrito.controller.ts             | 38 ++++++------
 src/equipo/equipo.controller.ts               | 14 ++---
 .../hora-excepcion.controller.ts              | 16 ++---
 .../institucion-dia.controller.ts             |  2 +-
 .../institucion-infraccion.controller.ts      |  2 +-
 .../institucion-tipo-carrito.controller.ts    |  2 +-
 .../institucion-tipo-entrada.controller.ts    |  2 +-
 src/modulo/modulo.controller.ts               |  2 +-
 src/motivo/motivo.controller.ts               |  2 +-
 src/multa/multa.controller.ts                 |  2 +-
 src/operador/dto/operador-operadores.dto.ts   |  2 +-
 src/operador/operador.controller.ts           | 61 ++++++++++++++++++-
 src/prestamo/prestamo.controller.ts           |  2 +-
 src/programa/programa.controller.ts           |  2 +-
 src/tipo-usuario/tipo-usuario.controller.ts   |  2 +-
 src/upload-file/upload-file.controller.ts     |  2 +-
 src/usuario/usuario.controller.ts             |  2 +-
 18 files changed, 117 insertions(+), 58 deletions(-)

diff --git a/src/carrera-programa/carrera-programa.controller.ts b/src/carrera-programa/carrera-programa.controller.ts
index 374c70f..f6046ff 100644
--- a/src/carrera-programa/carrera-programa.controller.ts
+++ b/src/carrera-programa/carrera-programa.controller.ts
@@ -5,14 +5,14 @@ import { CarreraProgramaUpdateDto } from './dto/carrera-programa-update.dto';
 import {ApiOperation, ApiTags} from '@nestjs/swagger'
 
 @Controller('carrera-programa')
-@ApiTags('carrera-programa')
+// @ApiTags('carrera-programa')
 export class CarreraProgramaController {
   constructor(private carreraProgramaService: CarreraProgramaService) {}
 
   @Post()
-  @ApiOperation({
-    description: 'Creamos una carrera programa, pasandole los parametros id_carrera y id_programa'
-  })
+  // @ApiOperation({
+  //   description: 'Creamos una carrera programa, pasandole los parametros id_carrera y id_programa'
+  // })
   create(@Body() body: CarreraProgramaCreateDto) {
     return this.carreraProgramaService.create(
       body.id_carrera,
@@ -21,17 +21,17 @@ export class CarreraProgramaController {
   }
 
   @Delete(':id')
-  @ApiOperation({
-    description: 'Borramos una carrera programa a partir del id (id_carrera_programa)'
-  })
+  // @ApiOperation({
+  //   description: 'Borramos una carrera programa a partir del id (id_carrera_programa)'
+  // })
   delete(@Param('id') id_carrera_programa: number) {
     return this.carreraProgramaService.delete(id_carrera_programa)
   }
 
   @Get()
-  @ApiOperation({
-    description: 'Nos trae todas las carrera-programa'
-  })
+  // @ApiOperation({
+  //   description: 'Nos trae todas las carrera-programa'
+  // })
   get() {
     return this.carreraProgramaService.findAll();
   }
diff --git a/src/carrito/carrito.controller.ts b/src/carrito/carrito.controller.ts
index 818b50a..9fc8e85 100644
--- a/src/carrito/carrito.controller.ts
+++ b/src/carrito/carrito.controller.ts
@@ -7,41 +7,41 @@ import { CarritoCarritosDto } from './dto/carrito-carritos-dto';
 import { CarritoDto } from './dto/carrito.dto';
 
 @Controller('carrito')
-@ApiTags('carrito')
+// @ApiTags('carrito')
 export class CarritoController {
   constructor(private carritoService: CarritoService) {}
 
   @Post()
-  @ApiOperation({
-    description:
-      'Creamos un carrito, pasandole los parametros id_tipo_carrito y id_modulo',
-  })
+  // @ApiOperation({
+  //   description:
+  //     'Creamos un carrito, pasandole los parametros id_tipo_carrito y id_modulo',
+  // })
   create(@Body() body: CarritoCreateDto) {
     return this.carritoService.create(body.id_tipo_carrito, body.id_modulo);
   }
 
   @Get()
-  @ApiOperation({
-    description: 'Nos trae todos los carritos',
-  })
+  // @ApiOperation({
+  //   description: 'Nos trae todos los carritos',
+  // })
   get() {
     return this.carritoService.findAll();
   }
 
   @Get('carrito')
-  @ApiOperation({
-    description:
-      'Nos trae un carrito en especifico, pasandole el parámetro id_carrito',
-  })
+  // @ApiOperation({
+  //   description:
+  //     'Nos trae un carrito en especifico, pasandole el parámetro id_carrito',
+  // })
   carrito(@Query() query: CarritoDto) {
     return this.carritoService.findById(parseInt(query.id_carrito));
   }
 
   @Get('carritos')
-  @ApiOperation({
-    description:
-      'Nos trae todos los carritos de un módulo, con el parámetro del id_modulo',
-  })
+  // @ApiOperation({
+  //   description:
+  //     'Nos trae todos los carritos de un módulo, con el parámetro del id_modulo',
+  // })
   carritos(@Query() query: CarritoCarritosDto) {
     return this.carritoService.findByIdModulo(query);
   }
@@ -50,9 +50,9 @@ export class CarritoController {
   carritosInstitucion() {}
 
   @Put()
-  @ApiOperation({
-    description: 'Actualizamos información de un carrito',
-  })
+  // @ApiOperation({
+  //   description: 'Actualizamos información de un carrito',
+  // })
   update(@Body() body: CarritoUpdateDto) {
     return this.carritoService.update(body);
   }
diff --git a/src/equipo/equipo.controller.ts b/src/equipo/equipo.controller.ts
index 64205b6..d59ef42 100644
--- a/src/equipo/equipo.controller.ts
+++ b/src/equipo/equipo.controller.ts
@@ -4,22 +4,22 @@ import { EquipoDto } from './dto/equipo.dto';
 import { ApiOperation, ApiTags } from '@nestjs/swagger';
 
 @Controller('equipo')
-@ApiTags('equipo')
+// @ApiTags('equipo')
 export class EquipoController {
   constructor(private equipoService: EquipoService) {}
 
   @Get()
-  @ApiOperation({
-    description: 'Traemos todos los equipos',
-  })
+  // @ApiOperation({
+  //   description: 'Traemos todos los equipos',
+  // })
   get() {
     return this.equipoService.findAll();
   }
 
   @Get('equipo')
-  @ApiOperation({
-    description: 'Buscamos un equipo en base al id_equipo',
-  })
+  // @ApiOperation({
+  //   description: 'Buscamos un equipo en base al id_equipo',
+  // })
   equipo(@Query() query: EquipoDto) {
     return this.equipoService.findById(parseInt(query.id_equipo));
   }
diff --git a/src/hora-excepcion/hora-excepcion.controller.ts b/src/hora-excepcion/hora-excepcion.controller.ts
index d8b44ca..1282d03 100644
--- a/src/hora-excepcion/hora-excepcion.controller.ts
+++ b/src/hora-excepcion/hora-excepcion.controller.ts
@@ -4,23 +4,23 @@ import { HoraExcepcionDto } from './dto/hora-excepcion-create.dto';
 import { ApiOperation, ApiTags } from '@nestjs/swagger';
 
 @Controller('hora-excepcion')
-@ApiTags('hora-excepcion')
+// @ApiTags('hora-excepcion')
 export class HoraExcepcionController {
   constructor(private horaExcepcionService: HoraExcepcionService) {}
 
   @Post()
-  @ApiOperation({
-    description: 'Creamos una institucion-dia con el id_institucion_dia',
-  })
+  // @ApiOperation({
+  //   description: 'Creamos una institucion-dia con el id_institucion_dia',
+  // })
   create(@Body() body: HoraExcepcionDto) {
     return this.horaExcepcionService.create(body.id_institucion_dia);
   }
 
   @Delete(':id')
-  @ApiOperation({
-    description:
-      'Con este delete borramos una hora_excepcion con ayuda de su id',
-  })
+  // @ApiOperation({
+  //   description:
+  //     'Con este delete borramos una hora_excepcion con ayuda de su id',
+  // })
   delete(@Param('id') id_hora_excepcion: number) {
     return this.horaExcepcionService.delete(id_hora_excepcion);
   }
diff --git a/src/institucion-dia/institucion-dia.controller.ts b/src/institucion-dia/institucion-dia.controller.ts
index 689277a..b7c1430 100644
--- a/src/institucion-dia/institucion-dia.controller.ts
+++ b/src/institucion-dia/institucion-dia.controller.ts
@@ -5,7 +5,7 @@ import { InstitucionDiaUpdateDto } from './dto/institucion-dia-update.dto';
 import {ApiTags} from '@nestjs/swagger'
 
 @Controller('institucion-dia')
-@ApiTags('institucion-dia')
+// @ApiTags('institucion-dia')
 export class InstitucionDiaController {
   constructor(private institucionDiaService: InstitucionDiaService) {}
 
diff --git a/src/institucion-infraccion/institucion-infraccion.controller.ts b/src/institucion-infraccion/institucion-infraccion.controller.ts
index e6d4468..496e20a 100644
--- a/src/institucion-infraccion/institucion-infraccion.controller.ts
+++ b/src/institucion-infraccion/institucion-infraccion.controller.ts
@@ -6,7 +6,7 @@ import { InstitucionInfraccionUpdateDto } from './dto/institucion-infraccion-upd
 import { ApiTags } from '@nestjs/swagger';
 
 @Controller('institucion-infraccion')
-@ApiTags('institucion-infraccion')
+// @ApiTags('institucion-infraccion')
 export class InstitucionInfraccionController {
   constructor(
     private institucionInfraccionService: InstitucionInfraccionService,
diff --git a/src/institucion-tipo-carrito/institucion-tipo-carrito.controller.ts b/src/institucion-tipo-carrito/institucion-tipo-carrito.controller.ts
index ffd7570..130e3fd 100644
--- a/src/institucion-tipo-carrito/institucion-tipo-carrito.controller.ts
+++ b/src/institucion-tipo-carrito/institucion-tipo-carrito.controller.ts
@@ -6,7 +6,7 @@ import { InstitucionTipoCarritoUpdateDto } from './dto/institucion-tipo-carrito-
 import { ApiTags } from '@nestjs/swagger';
 
 @Controller('institucion-tipo-carrito')
-@ApiTags('institucion-tipo-carrito')
+// @ApiTags('institucion-tipo-carrito')
 export class InstitucionTipoCarritoController {
   constructor(
     private institucionTipoCarritoService: InstitucionTipoCarritoService,
diff --git a/src/institucion-tipo-entrada/institucion-tipo-entrada.controller.ts b/src/institucion-tipo-entrada/institucion-tipo-entrada.controller.ts
index c04f853..e5bdc81 100644
--- a/src/institucion-tipo-entrada/institucion-tipo-entrada.controller.ts
+++ b/src/institucion-tipo-entrada/institucion-tipo-entrada.controller.ts
@@ -5,7 +5,7 @@ import { IdInstitucionDto } from 'src/dto/id-institucion.dto';
 import { InstitucionTipoEntradaCreateDto } from './dto/institucion-tipo-entrada-create.dto';
 
 @Controller('institucion-tipo-entrada')
-@ApiTags('institucion-tipo-entrada')
+// @ApiTags('institucion-tipo-entrada')
 export class InstitucionTipoEntradaController {
   constructor(private tipoEntradaService: InstitucionTipoEntradaService) {}
 
diff --git a/src/modulo/modulo.controller.ts b/src/modulo/modulo.controller.ts
index 7981547..7a473b6 100644
--- a/src/modulo/modulo.controller.ts
+++ b/src/modulo/modulo.controller.ts
@@ -16,7 +16,7 @@ import { ModuloUpdateDto } from './dto/modulo-update.dto';
 // import { Serealize } from '../interceptors/serialize.interceptor';
 
 @Controller('modulo')
-@ApiTags('modulo')
+// @ApiTags('modulo')
 export class ModuloController {
   constructor(private moduloService: ModuloService) {}
 
diff --git a/src/motivo/motivo.controller.ts b/src/motivo/motivo.controller.ts
index c90e614..d7ca263 100644
--- a/src/motivo/motivo.controller.ts
+++ b/src/motivo/motivo.controller.ts
@@ -4,7 +4,7 @@ import { MotivoDto } from './dto/motivo.dto';
 import {ApiTags} from '@nestjs/swagger'
 
 @Controller('motivo')
-@ApiTags('motivo')
+// @ApiTags('motivo')
 export class MotivoController {
   constructor(private motivoService: MotivoService) {}
 
diff --git a/src/multa/multa.controller.ts b/src/multa/multa.controller.ts
index a96c457..8474b9b 100644
--- a/src/multa/multa.controller.ts
+++ b/src/multa/multa.controller.ts
@@ -3,7 +3,7 @@ import { MultaService } from './multa.service';
 import {ApiTags} from '@nestjs/swagger'
 
 @Controller('multa')
-@ApiTags('multa')
+// @ApiTags('multa')
 export class MultaController {
   constructor(private multaService: MultaService) {}
 
diff --git a/src/operador/dto/operador-operadores.dto.ts b/src/operador/dto/operador-operadores.dto.ts
index 049b89e..56e30d2 100644
--- a/src/operador/dto/operador-operadores.dto.ts
+++ b/src/operador/dto/operador-operadores.dto.ts
@@ -10,7 +10,7 @@ export class OperadorOperadoresDto {
 
   @IsNumberString()
   @IsOptional()
-  id_tipo_usuario: string;
+  id_tipo_usuario?: string;
 
   @IsString()
   @IsOptional()
diff --git a/src/operador/operador.controller.ts b/src/operador/operador.controller.ts
index 0366ad6..4422570 100644
--- a/src/operador/operador.controller.ts
+++ b/src/operador/operador.controller.ts
@@ -8,7 +8,7 @@ import {
   UseGuards,
 } from '@nestjs/common';
 import { AuthGuard } from '@nestjs/passport';
-import { ApiTags } from '@nestjs/swagger';
+import { ApiBody, ApiOperation, ApiQuery, ApiTags } from '@nestjs/swagger';
 import { OperadorService } from './operador.service';
 import { OperadorCreateDto } from './dto/operador-create.dto';
 import { OperadorOperadoresDto } from './dto/operador-operadores.dto';
@@ -22,6 +22,20 @@ export class OperadorController {
 
   @Post()
   // @UseGuards(AuthGuard('jwt'))
+  @ApiOperation({ description: 'Endpoint que crea un operador.' })
+  @ApiBody({
+    description: 'Todas las variables son obligatorias.',
+    examples: {
+      ejemplo: {
+        value: {
+          id_institucion: 200,
+          id_tipo_usuario: 4,
+          operador: '',
+          password: '',
+        },
+      },
+    },
+  })
   create(@Body() body: OperadorCreateDto) {
     return this.operadorService.create(
       body.id_institucion,
@@ -33,12 +47,47 @@ export class OperadorController {
 
   @Get('operador')
   // @UseGuards(AuthGuard('jwt'))
+  @ApiOperation({
+    description: 'Endpoint que retorna la información de un operador.',
+  })
+  @ApiQuery({
+    description: 'Id del operador.',
+    name: 'id_operador',
+    type: 'string',
+  })
   operador(@Query() query: OperadorDto) {
     return this.operadorService.findById(parseInt(query.id_operador));
   }
 
   @Get('operadores')
   // @UseGuards(AuthGuard('jwt'))
+  @ApiOperation({
+    description:
+      'Endpoint que retorna 25 operadores dependiendo de la página en la que se encuentra el usuario y sus filtros.',
+  })
+  @ApiQuery({
+    description: 'Página en la que se encuentra el usuario.',
+    name: 'pagina',
+    type: 'string',
+  })
+  @ApiQuery({
+    description: 'Id de la institución que se queire usar como filtro.',
+    name: 'id_institucion',
+    type: 'string',
+    required: false,
+  })
+  @ApiQuery({
+    description: 'Id del tipo usuario que se queire usar como filtro.',
+    name: 'id_tipo_usuario',
+    type: 'string',
+    required: false,
+  })
+  @ApiQuery({
+    description: 'Operador que se queire buscar.',
+    name: 'operador',
+    type: 'string',
+    required: false,
+  })
   operadores(@Query() query: OperadorOperadoresDto) {
     return this.operadorService.findAll(query);
   }
@@ -49,6 +98,16 @@ export class OperadorController {
 
   @Put()
   // @UseGuards(AuthGuard('jwt'))
+  @ApiOperation({
+    description: 'Endpoint que actualiza la información de un operador.',
+  })
+  @ApiBody({
+    description:
+      'Todas las variables a excepción de id_operador son opcionales.',
+    examples: {
+      ejemplo: { value: { id_operador: 3, activo: true, password: '' } },
+    },
+  })
   update(@Body() body: OperadorUpdateDto) {
     return this.operadorService.update(body);
   }
diff --git a/src/prestamo/prestamo.controller.ts b/src/prestamo/prestamo.controller.ts
index cfd6369..f5764a8 100644
--- a/src/prestamo/prestamo.controller.ts
+++ b/src/prestamo/prestamo.controller.ts
@@ -3,7 +3,7 @@ import { PrestamoService } from './prestamo.service';
 import {ApiTags} from '@nestjs/swagger'
 
 @Controller('prestamo')
-@ApiTags('prestamo')
+// @ApiTags('prestamo')
 export class PrestamoController {
   constructor(private prestamoService: PrestamoService) {}
 
diff --git a/src/programa/programa.controller.ts b/src/programa/programa.controller.ts
index 2f8d549..f242edc 100644
--- a/src/programa/programa.controller.ts
+++ b/src/programa/programa.controller.ts
@@ -5,7 +5,7 @@ import { ProgramaCreateDto } from './dto/programa-create.dto';
 import { ProgramaDto } from './dto/programa.dto';
 
 @Controller('programa')
-@ApiTags('programa')
+// @ApiTags('programa')
 export class ProgramaController {
   constructor(private programaService: ProgramaService) {}
 
diff --git a/src/tipo-usuario/tipo-usuario.controller.ts b/src/tipo-usuario/tipo-usuario.controller.ts
index 1355e82..8ee1497 100644
--- a/src/tipo-usuario/tipo-usuario.controller.ts
+++ b/src/tipo-usuario/tipo-usuario.controller.ts
@@ -4,7 +4,7 @@ import { TipoUsuarioUpdateDto } from './dto/tipo-usuario-update.dto';
 import {ApiTags} from '@nestjs/swagger'
 
 @Controller('tipo-usuario')
-@ApiTags('tipo-usuario')
+// @ApiTags('tipo-usuario')
 export class TipoUsuarioController {
   constructor(private tipoUsuarioService: TipoUsuarioService) {}
 
diff --git a/src/upload-file/upload-file.controller.ts b/src/upload-file/upload-file.controller.ts
index 52fd6af..6aaec79 100644
--- a/src/upload-file/upload-file.controller.ts
+++ b/src/upload-file/upload-file.controller.ts
@@ -14,7 +14,7 @@ import { UploadFileEquipo } from './dto/upload-file-equipo'
 import { ApiTags } from '@nestjs/swagger';
 
 @Controller('upload-file')
-@ApiTags('upload-file')
+// @ApiTags('upload-file')
 export class UploadFileController {
   constructor(private uploadFileService: UploadFileService) {}
 
diff --git a/src/usuario/usuario.controller.ts b/src/usuario/usuario.controller.ts
index 4134ffe..e395ad1 100644
--- a/src/usuario/usuario.controller.ts
+++ b/src/usuario/usuario.controller.ts
@@ -17,7 +17,7 @@ import { UsuarioUsuariosDto } from './dto/usuario-usuarios.dto';
 import { UsuarioDto } from './dto/usuario.dto';
 
 @Controller('usuario')
-@ApiTags('usuario')
+// @ApiTags('usuario')
 export class UsuarioController {
   constructor(private usuarioService: UsuarioService) {}