WIP: Documentation of input API

src/modules/inputs/dtos/input.model.ts

@@ -1,3 +1,5 @@
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
+
 export class InputModel {
   category: string;
   plugin: string;
@@ -18,3 +20,183 @@ export class InputModel {
     };
   };
 }
+
+class GoogleAnalyticsClientSecrets {
+  @ApiProperty()
+  type: string;
+  @ApiProperty()
+  project_id: string;
+  @ApiProperty()
+  private_key_id: string;
+  @ApiProperty()
+  private_key: string;
+  @ApiProperty()
+  client_email: string;
+  @ApiProperty()
+  client_id: string;
+  @ApiProperty()
+  auth_uri: string;
+  @ApiProperty()
+  token_uri: string;
+  @ApiProperty()
+  auth_provider_x509_cert_url: string;
+  @ApiProperty()
+  client_x509_cert_url: string;
+}
+class OauthObject {
+  @ApiPropertyOptional()
+  get_tokens_url: string;
+  @ApiPropertyOptional()
+  get_tokens_url_params: string;
+  @ApiPropertyOptional()
+  get_tokens_set_response: Record<string, any>;
+  @ApiPropertyOptional()
+  content_type: string;
+}
+class InputOptions {
+  @ApiPropertyOptional()
+  oauth: OauthObject;
+  @ApiPropertyOptional()
+  skip_select_columns: true;
+  @ApiPropertyOptional()
+  skip_select_entities: false;
+  @ApiPropertyOptional()
+  skip_transformation: true;
+}
+
+class CredentialsJdbc {
+  @ApiPropertyOptional()
+  jdbc_user: string;
+  @ApiPropertyOptional()
+  jdbc_password: string;
+  @ApiPropertyOptional()
+  database: string;
+  @ApiPropertyOptional()
+  endpoint: string;
+  @ApiPropertyOptional()
+  port: string;
+  @ApiPropertyOptional()
+  engine: string;
+  @ApiPropertyOptional()
+  schema: string;
+}
+class FileFormatParams {
+  @ApiPropertyOptional()
+  file_format: string;
+  @ApiPropertyOptional()
+  encoding: string;
+}
+
+class Credentials extends CredentialsJdbc {
+  @ApiProperty()
+  connection_type: string;
+
+  @ApiPropertyOptional()
+  client_aws_access_key_id: string;
+  @ApiPropertyOptional()
+  client_aws_secret_access_key: string;
+  @ApiPropertyOptional()
+  client_bucket: string;
+  @ApiPropertyOptional()
+  file_to_extract: string;
+  @ApiPropertyOptional()
+  file_format_params: FileFormatParams;
+
+  @ApiPropertyOptional()
+  view_id: string;
+  @ApiPropertyOptional()
+  client_secrets: GoogleAnalyticsClientSecrets;
+  @ApiPropertyOptional()
+  start_date: string;
+  @ApiPropertyOptional()
+  end_date: string;
+
+  @ApiPropertyOptional()
+  oauth_code: string;
+}
+class Column {
+  @ApiProperty()
+  name: string;
+  @ApiProperty()
+  type: string;
+}
+class TableColumns {
+  @ApiProperty()
+  name: string;
+  @ApiProperty()
+  columns: Column[];
+  @ApiProperty()
+  references: Column[];
+}
+export class GetAvailableEntitiesReq {
+  @ApiProperty()
+  plugin: string;
+}
+
+export class GetAvailableEntitiesRes {
+  @ApiProperty()
+  entities: string[];
+}
+
+export class TestConnectionGetColumnsReq {
+  @ApiProperty()
+  plugin: string;
+  @ApiProperty()
+  tables: string[];
+  @ApiPropertyOptional()
+  credentials: CredentialsJdbc;
+  @ApiPropertyOptional()
+  id: string;
+}
+export class TestConnectionGetColumnsRes {
+  @ApiProperty()
+  tables: TableColumns[];
+}
+
+export class TestConnectionReq {
+  @ApiProperty()
+  plugin: string;
+  @ApiProperty()
+  credentials: CredentialsJdbc;
+}
+export class TestConnectionRes {
+  @ApiProperty()
+  connection_state: boolean;
+  @ApiProperty()
+  total_entities: number;
+  @ApiProperty()
+  database_tables: string[];
+}
+export class CreateInputReq {
+  @ApiProperty()
+  plugin: string;
+  @ApiProperty()
+  category: string;
+  @ApiProperty()
+  credentials: Credentials;
+  @ApiProperty()
+  name: string;
+  @ApiPropertyOptional()
+  options: InputOptions;
+}
+
+export class Input {
+  @ApiProperty()
+  id: string;
+  @ApiProperty()
+  category: string;
+  @ApiProperty()
+  plugin: string;
+  @ApiProperty()
+  name: string;
+  @ApiProperty()
+  cron: string;
+  @ApiProperty()
+  credentials: Credentials;
+  @ApiProperty()
+  client_id: string;
+  @ApiProperty()
+  created_at: string;
+  @ApiProperty()
+  updated_at: string;
+}

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