From 934387cef72eeebcb3d5d19d9e2e428178cd9823 Mon Sep 17 00:00:00 2001 From: xXpuma99Xx <51341582+xXpuma99Xx@users.noreply.github.com> Date: Mon, 30 May 2022 18:03:41 -0500 Subject: [PATCH] =?UTF-8?q?instituci=C3=B3n=20infracci=C3=B3n=20documentac?= =?UTF-8?q?i=C3=B3n?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../institucion-infraccion.controller.ts | 28 +++++++++++++++++-- .../institucion-infraccion.service.ts | 4 +-- 2 files changed, 28 insertions(+), 4 deletions(-) diff --git a/src/institucion-infraccion/institucion-infraccion.controller.ts b/src/institucion-infraccion/institucion-infraccion.controller.ts index 496e20a..1cf33e0 100644 --- a/src/institucion-infraccion/institucion-infraccion.controller.ts +++ b/src/institucion-infraccion/institucion-infraccion.controller.ts @@ -3,26 +3,41 @@ import { InstitucionInfraccionService } from './institucion-infraccion.service'; import { IdInstitucionDto } from '../dto/id-institucion.dto'; import { InstitucionInfraccionCreateDto } from './dto/institucion-infraccion-create.dto'; import { InstitucionInfraccionUpdateDto } from './dto/institucion-infraccion-update.dto'; -import { ApiTags } from '@nestjs/swagger'; +import { ApiBody, ApiOperation, ApiQuery, ApiTags } from '@nestjs/swagger'; +import e from 'express'; @Controller('institucion-infraccion') -// @ApiTags('institucion-infraccion') +@ApiTags('institucion-infraccion') export class InstitucionInfraccionController { constructor( private institucionInfraccionService: InstitucionInfraccionService, ) {} @Post() + @ApiOperation({ description: 'Endpoint que crea una infracción.' }) + @ApiBody({ + description: 'Es obligatorio mandar la variable infraccion.', + examples: { ejemplo: { value: { infraccion: '' } } }, + }) create(@Body() body: InstitucionInfraccionCreateDto) { return this.institucionInfraccionService.create(body.infraccion); } @Get() + @ApiOperation({ description: 'Endpoint que retorna todas las infracciones.' }) get() { return this.institucionInfraccionService.findAll(); } @Get('infracciones') + @ApiOperation({ + description: 'Endpoint que retorna las infracciones de una institución.', + }) + @ApiQuery({ + description: 'Id de la institución.', + name: 'id_institucion', + type: 'string', + }) infracciones(@Query() query: IdInstitucionDto) { return this.institucionInfraccionService.findAllByIdInstitucion( parseInt(query.id_institucion), @@ -30,6 +45,15 @@ export class InstitucionInfraccionController { } @Put() + @ApiOperation({ + description: 'Endpoint que actualiza los días de multa de una infracción.', + }) + @ApiBody({ + description: 'Las dos variables son obligatorias.', + examples: { + ejemplo: { value: { id_institucion_infraccion: 603, dias_multa: 7 } }, + }, + }) update(@Body() body: InstitucionInfraccionUpdateDto) { return this.institucionInfraccionService.update(body); } diff --git a/src/institucion-infraccion/institucion-infraccion.service.ts b/src/institucion-infraccion/institucion-infraccion.service.ts index 33c1723..9332edf 100644 --- a/src/institucion-infraccion/institucion-infraccion.service.ts +++ b/src/institucion-infraccion/institucion-infraccion.service.ts @@ -39,7 +39,7 @@ export class InstitucionInfraccionService { institucion: instituciones[i], }), ); - return { message: 'Se creo creo correctamente la infracción.' }; + return { message: 'Se creó creo correctamente la infracción.' }; }); } @@ -72,7 +72,7 @@ export class InstitucionInfraccionService { return this.repositoryInstitucionInfraccion.save(institucionInfraccion); }) .then((_) => ({ - message: 'Se actualió correctamente la institucion infracción.', + message: 'Se actualizó correctamente la institucion infracción.', })); } }