WIP: Documentation of input API

src/modules/inputs/inputs.controller.ts

@@ -10,23 +10,40 @@ import {
 import { InputsService } from './inputs.service';
 import { InputsClientService } from 'src/clients/inputs/client.service';
 import { UpdateInputRequest } from 'src/clients/inputs/interfaces';
-import { InputNewCreateRequest } from '@victorradael/protospack';
+import { ApiOkResponse, ApiTags } from '@nestjs/swagger';
+import {
+  CreateInputReq,
+  GetAvailableEntitiesReq,
+  GetAvailableEntitiesRes,
+  Input,
+  TestConnectionGetColumnsReq,
+  TestConnectionGetColumnsRes,
+  TestConnectionReq,
+  TestConnectionRes,
+} from './dtos/input.model';
 
+@ApiTags('inputs')
 @Controller('inputs')
 export class InputsController {
   inputService: InputsService;
   constructor(private inputsClientService: InputsClientService) {
     this.inputService = new InputsService(this.inputsClientService);
   }
+
   @Get('available-entities/:plugin')
-  async getAvailableEntities(@Body() body, @Param() params) {
+  @ApiOkResponse({ type: GetAvailableEntitiesRes })
+  async getAvailableEntities(
+    @Body() body,
+    @Param() params: GetAvailableEntitiesReq,
+  ) {
     const { info } = body;
     const { plugin } = params;
     return await this.inputService.getAvailableEntities({ info, plugin });
   }
 
   @Post('/test-connection')
-  async testConnection(@Body() data) {
+  @ApiOkResponse({ type: TestConnectionRes })
+  async testConnection(@Body() data: TestConnectionReq) {
     console.log(`/test-connection`, 'ON TEST CONNECTION ROUTE');
 
     const inputService = new InputsService(this.inputsClientService);
@@ -36,7 +53,8 @@ export class InputsController {
   }
 
   @Post('/test-connection/get-columns')
-  async getColumns(@Body() data) {
+  @ApiOkResponse({ type: TestConnectionGetColumnsRes })
+  async getColumns(@Body() data: TestConnectionGetColumnsReq) {
     console.log(
       `/test-connection/get-columns`,
       'ON TEST CONNECTION GET COLUMNS ROUTE',
@@ -49,7 +67,8 @@ export class InputsController {
   }
 
   @Post()
-  async create(@Body() createInputDto: InputNewCreateRequest) {
+  @ApiOkResponse({ type: Input })
+  async create(@Body() createInputDto: CreateInputReq) {
     console.log(`/input`, 'ON CREATE ROUTE');
 
     const inputService = new InputsService(this.inputsClientService);