institución tipo carrito documentación

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);
   }