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

---
 .../institucion-tipo-carrito.controller.ts    | 40 ++++++++++++++++++-
 1 file changed, 38 insertions(+), 2 deletions(-)

diff --git a/src/institucion-tipo-carrito/institucion-tipo-carrito.controller.ts b/src/institucion-tipo-carrito/institucion-tipo-carrito.controller.ts
index 130e3fd..f0aa17f 100644
--- a/src/institucion-tipo-carrito/institucion-tipo-carrito.controller.ts
+++ b/src/institucion-tipo-carrito/institucion-tipo-carrito.controller.ts
@@ -1,18 +1,23 @@
 import { Body, Controller, Get, Post, Put, Query } from '@nestjs/common';
+import { ApiBody, ApiOperation, ApiQuery, ApiTags } from '@nestjs/swagger';
 import { InstitucionTipoCarritoService } from './institucion-tipo-carrito.service';
 import { IdInstitucionDto } from '../dto/id-institucion.dto';
 import { InstitucionTipoCarritoCreateDto } from './dto/institucion-tipo-carrito-create.dto';
 import { InstitucionTipoCarritoUpdateDto } from './dto/institucion-tipo-carrito-update.dto';
-import { ApiTags } from '@nestjs/swagger';
 
 @Controller('institucion-tipo-carrito')
-// @ApiTags('institucion-tipo-carrito')
+@ApiTags('institucion-tipo-carrito')
 export class InstitucionTipoCarritoController {
   constructor(
     private institucionTipoCarritoService: InstitucionTipoCarritoService,
   ) {}
 
   @Post()
+  @ApiOperation({ description: 'Endpoint que crea un tipo de carrito.' })
+  @ApiBody({
+    description: 'Ambas variables son obligatorias.',
+    examples: { ejemplo: { value: { letra: '', tipo_carrito: '' } } },
+  })
   create(@Body() body: InstitucionTipoCarritoCreateDto) {
     return this.institucionTipoCarritoService.create(
       body.letra,
@@ -21,11 +26,23 @@ export class InstitucionTipoCarritoController {
   }
 
   @Get()
+  @ApiOperation({
+    description: 'Endpoint que retorna todos los tipos de carrito.',
+  })
   get() {
     return this.institucionTipoCarritoService.findAll();
   }
 
   @Get('tipos-carrito')
+  @ApiOperation({
+    description:
+      'Endpoint que retorna todos los tipos de carrito de una institución.',
+  })
+  @ApiQuery({
+    description: 'Id de la institución.',
+    name: 'id_institucion',
+    type: 'string',
+  })
   tiposCarrito(@Query() query: IdInstitucionDto) {
     return this.institucionTipoCarritoService.findAllByIdInstitucion(
       parseInt(query.id_institucion),
@@ -33,6 +50,15 @@ export class InstitucionTipoCarritoController {
   }
 
   @Get('tipos-carrito-mostar')
+  @ApiOperation({
+    description:
+      'Endpoint que retorna todos los tipos de carrito de una institución que tengan el campo mostrar en true.',
+  })
+  @ApiQuery({
+    description: 'Id de la institución.',
+    name: 'id_institucion',
+    type: 'string',
+  })
   tiposCarritoMostrar(@Query() query: IdInstitucionDto) {
     return this.institucionTipoCarritoService.findAllByIdInstitucionMostar(
       parseInt(query.id_institucion),
@@ -40,6 +66,16 @@ export class InstitucionTipoCarritoController {
   }
 
   @Put()
+  @ApiOperation({
+    description:
+      'Endpoint que actualiza el campo mostrar de una institución tipo carrito.',
+  })
+  @ApiBody({
+    description: 'Ambas variables son obligatorias.',
+    examples: {
+      ejemplo: { value: { id_institucion_tipo_carrito: 130, mostrar: true } },
+    },
+  })
   update(@Body() body: InstitucionTipoCarritoUpdateDto) {
     return this.institucionTipoCarritoService.update(body);
   }