DOCS: update some routes swagger

src/modules/connection/connection.controller.ts

@@ -24,6 +24,7 @@ import {
   ConnectionDetailsRes,
   ConnectionRes,
   ConnectionsRes,
+  GetAllConnectionsReq,
   UpdateConnectionDto,
 } from './dtos/connection';
 import { CreateConnectionDto } from './dtos/connection';
@@ -138,7 +139,7 @@ export class ConnectionController {
   async getAllConnections(
     @User() user: RequestUser,
     @Language() language: LanguageEnum,
-    @Query() queries,
+    @Query() queries: GetAllConnectionsReq,
   ): Promise<ConnectionsRes> {
     this.logger.info('/connections - Get All Connection');
 

src/modules/connection/dtos/connection.ts

@@ -9,6 +9,7 @@ import {
   ConnectionToCatalog,
 } from '@dadosfera/protospack-v2/dist/lib/ConnectionManager/interfaces/entities';
 import {
+  GetAllConnectionRequest,
   GetAllConnectionResponse,
   GetConnectionDetailsResponse,
   GetConnectionResponse,
@@ -21,7 +22,7 @@ export type ConnectionCredentialsType =
   | 'oauth'
   | 'api_key'
   | 'service_account'
-  | 'headers_authF';
+  | 'headers_auth';
 export interface ConnectionApiConnection {
   config_id: string;
   plugin: string;
@@ -94,7 +95,6 @@ export class ConnectionDto implements Connection {
 
 export class ConnectionToCatalogDto implements ConnectionToCatalog {
   // ---Automatically generated information - will not be sent by the frontend--- //
-  id: string;
   customer_id: string;
   updated_at: string;
   created_at: string;
@@ -104,6 +104,9 @@ export class ConnectionToCatalogDto implements ConnectionToCatalog {
   customer_name: string;
 
   // ---Information sent by the frontend--- //
+  @ApiPropertyOptional()
+  id: string;
+
   @ApiProperty()
   name: string;
 
@@ -147,6 +150,15 @@ export class UpdateConnectionDto extends PickType(ConnectionDto, [
   'properties',
 ]) {}
 
+export class GetAllConnectionsReq implements GetAllConnectionRequest {
+  @ApiPropertyOptional()
+  search?: string;
+  @ApiPropertyOptional()
+  page?: string;
+  @ApiPropertyOptional()
+  size?: string;
+}
+
 export class ConnectionsRes implements GetAllConnectionResponse {
   @ApiProperty({ type: [ConnectionToCatalogDto] })
   connections: ConnectionToCatalogDto[];

src/modules/customers/customers.controller.ts

@@ -4,26 +4,27 @@ import {
   Body,
   Controller,
   Get,
+  HttpCode,
+  HttpStatus,
   Inject,
   Param,
   Put,
   Query,
   UseFilters,
 } from '@nestjs/common';
-import { ApiTags } from '@nestjs/swagger';
+import { ApiOkResponse, ApiProduces, ApiTags } from '@nestjs/swagger';
 import { PERMISSIONS_GROUPS } from 'src/authentication/permissions.enum';
 import {
   Authenticated,
   RequireAllPermissions,
 } from 'src/decorators/authentication.decorator';
-import { ApiInternalOnlyController } from 'src/decorators/swagger.decorator';
+import { ApiInternalOnlyEndpoint } from 'src/decorators/swagger.decorator';
 import { GrpcToHttpExceptionFilter } from 'src/error/grpc-to-http-exception.filter';
 import { CustomersService } from './customers.service';
-import { CustomerDto, CustomerLinksResponse } from './dtos/customers';
+import { CustomerLinkRequest, CustomerLinksResponse } from './dtos/customers';
 import { RequestUser, User } from 'src/decorators/user.decorator';
 import type { StringValue } from 'ms';
 
-@ApiInternalOnlyController()
 @ApiTags('Customers')
 @Controller('customers')
 @Authenticated()
@@ -40,7 +41,8 @@ export class CustomersController {
   }
 
   @Get(':id/links')
-  async getCustomerLinks(@Param('id') id): Promise<CustomerLinksResponse> {
+  @ApiOkResponse({ type: CustomerLinksResponse })
+  async getCustomerLinks(@Param('id') id: string) {
     this.logger.info('getCustomerLinks', { id });
     const links = await this.customersService.getLinks(id);
     return { links };
@@ -48,17 +50,20 @@ export class CustomersController {
 
   @Put(':id/links')
   @RequireAllPermissions(PERMISSIONS_GROUPS.USERS.permissions.ADMIN)
-  setCustomerLinks(
-    @Body() body: CustomerDto,
-    @Param('id') id,
-  ): Promise<IdResponse> {
+  @ApiOkResponse()
+  @HttpCode(HttpStatus.OK)
+  async setCustomerLinks(
+    @Body() body: CustomerLinkRequest,
+    @Param('id') id: string,
+  ) {
     const { links } = body;
     this.logger.info('setCustomerLinks', { id, links });
-    return this.customersService.setLinks(id, links);
+    await this.customersService.setLinks(id, links);
   }
 
   @Get('token')
   @RequireAllPermissions(PERMISSIONS_GROUPS.AUTH.permissions.GENERATE_TOKEN)
+  @ApiProduces('text/plain')
   async getCustomerToken(
     @Query('exp') exp: StringValue,
     @User() user: RequestUser,

src/modules/customers/dtos/customers.ts

@@ -1,12 +1,22 @@
 import { Link } from '@dadosfera/protospack-v2/dist/lib/Duc/interfaces/entities';
-import { ApiProperty } from '@nestjs/swagger';
+import { ApiProperty, ApiPropertyOptional } from '@nestjs/swagger';
 
-export class CustomerDto {
+export class CustomerLink implements Link {
   @ApiProperty()
-  links: Link[];
+  href: string;
+  @ApiProperty()
+  name: string;
+  @ApiProperty()
+  description: string;
+  @ApiPropertyOptional()
+  iconSrc: string;
+}
+export class CustomerLinkRequest {
+  @ApiProperty({ type: [CustomerLink] })
+  links: CustomerLink[];
 }
 
 export class CustomerLinksResponse {
-  @ApiProperty()
-  links: Link[];
+  @ApiProperty({ type: [CustomerLink] })
+  links: CustomerLink[];
 }