chore: Update ApiTags decorator in KeyringsController to 'core/keyrings'

tacxou · tacxou · commit c89ba5e9ea9a · 2024-06-20T11:15:03.000+02:00
diff --git a/src/_common/decorators/api-create.decorator.ts b/src/_common/decorators/api-create.decorator.ts
@@ -1,17 +1,19 @@
 import { applyDecorators, Type } from '@nestjs/common';
 import { ApiBodyOptions } from '@nestjs/swagger';
-import { ApiBodyDecorator } from '~/_common/decorators/api-body.decorator';
 import { ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator';
+import { ApiBodyDecorator } from '~/_common/decorators/api-body.decorator';
 import { ApiCreatedResponseDecorator } from '~/_common/decorators/api-created-response.decorator';
 
 export const ApiCreateDecorator = <TModel extends Type<NonNullable<unknown>>>(
   bodyModel: TModel,
   responseModel: TModel,
-  bodyOptions?: ApiBodyOptions | null | undefined,
-  responseOptions?: ApiResponseOptions | null | undefined,
+  options?: {
+    bodyOptions?: ApiBodyOptions | null | undefined,
+    responseOptions?: ApiResponseOptions | null | undefined,
+  },
 ) => {
   return applyDecorators(
-    ApiBodyDecorator(bodyModel, bodyOptions),
-    ApiCreatedResponseDecorator(responseModel, responseOptions),
+    ApiBodyDecorator(bodyModel, options?.bodyOptions),
+    ApiCreatedResponseDecorator(responseModel, { responseOptions: options?.responseOptions }),
   );
 };
diff --git a/src/_common/decorators/api-created-response.decorator.ts b/src/_common/decorators/api-created-response.decorator.ts
@@ -1,11 +1,14 @@
 import { applyDecorators, HttpStatus, Type } from '@nestjs/common';
-import { ApiBadRequestResponse, ApiCreatedResponse, ApiExtraModels, getSchemaPath } from '@nestjs/swagger';
+import { ApiBadRequestResponse, ApiCreatedResponse, ApiExtraModels, ApiOperation, ApiOperationOptions, getSchemaPath } from '@nestjs/swagger';
 import { ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator';
 import { ErrorSchemaDto } from '~/_common/dto/error-schema.dto';
 
 export const ApiCreatedResponseDecorator = <TModel extends Type<NonNullable<unknown>>>(
   model: TModel,
-  options?: ApiResponseOptions | null | undefined,
+  options?: {
+    responseOptions?: ApiResponseOptions | null | undefined,
+    operationOptions?: ApiOperationOptions | null | undefined,
+  }
 ) => {
   return applyDecorators(
     ApiExtraModels(model),
@@ -22,13 +25,14 @@ export const ApiCreatedResponseDecorator = <TModel extends Type<NonNullable<unkn
           },
         },
       },
-      ...options,
+      ...options?.responseOptions,
     }),
     ApiBadRequestResponse({
       description: 'Schema validation failed',
       schema: {
         $ref: getSchemaPath(ErrorSchemaDto),
       },
     }),
+    ApiOperation({ summary: `Création d'une nouvelle entrée <${model.name.replace(/Dto$/, '')}>`, ...options?.operationOptions }),
   );
 };
diff --git a/src/_common/decorators/api-deleted-response.decorator.ts b/src/_common/decorators/api-deleted-response.decorator.ts
@@ -1,12 +1,15 @@
 import { applyDecorators, HttpStatus, Type } from '@nestjs/common';
-import { ApiExtraModels, ApiNotFoundResponse, getSchemaPath } from '@nestjs/swagger';
+import { ApiExtraModels, ApiNotFoundResponse, ApiOperation, ApiOperationOptions, getSchemaPath } from '@nestjs/swagger';
 import { ApiOkResponse, ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator';
 import { NotFoundDto } from '~/_common/dto/not-found.dto';
 
 export const ApiDeletedResponseDecorator = <TModel extends Type<NonNullable<unknown>>>(
   model: TModel,
-  responseOptions?: ApiResponseOptions | null | undefined,
-  notFoundOptions?: ApiResponseOptions | null | undefined,
+  options?: {
+    responseOptions?: ApiResponseOptions | null | undefined,
+    notFoundOptions?: ApiResponseOptions | null | undefined,
+    operationOptions?: ApiOperationOptions | null | undefined,
+  },
 ) => {
   return applyDecorators(
     ApiExtraModels(model),
@@ -23,14 +26,15 @@ export const ApiDeletedResponseDecorator = <TModel extends Type<NonNullable<unkn
           },
         },
       },
-      ...responseOptions,
+      ...options?.responseOptions,
     }),
     ApiNotFoundResponse({
       description: 'Item not found',
       schema: {
         $ref: getSchemaPath(NotFoundDto),
       },
-      ...notFoundOptions,
+      ...options?.notFoundOptions,
     }),
+    ApiOperation({ summary: `Suppression d'une entrée <${model.name.replace(/Dto$/, '')}>`, ...options?.operationOptions }),
   );
 };
diff --git a/src/_common/decorators/api-paginated-response.decorator.ts b/src/_common/decorators/api-paginated-response.decorator.ts
@@ -1,12 +1,15 @@
 import { applyDecorators, HttpStatus, Type } from '@nestjs/common';
-import { ApiExtraModels, getSchemaPath } from '@nestjs/swagger';
+import { ApiExtraModels, ApiOperation, ApiOperationOptions, getSchemaPath } from '@nestjs/swagger';
 import { ApiOkResponse, ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator';
 import { PaginatedResponseDto } from '~/_common/dto/paginated-response.dto';
 
 // eslint-disable-next-line
 export const ApiPaginatedResponseDecorator = <TModel extends Type<any>>(
   model: TModel,
-  options?: ApiResponseOptions | null | undefined,
+  options?: {
+    responseOptions?: ApiResponseOptions | null | undefined,
+    operationOptions?: ApiOperationOptions | null | undefined,
+  },
 ) => {
   return applyDecorators(
     ApiExtraModels(model),
@@ -28,7 +31,8 @@ export const ApiPaginatedResponseDecorator = <TModel extends Type<any>>(
           },
         ],
       },
-      ...options,
+      ...options?.responseOptions,
     }),
+    ApiOperation({ summary: `Liste les entrées <${model.name.replace(/Dto$/, '')}> avec pagination et filtres`, ...options?.operationOptions }),
   );
 };
diff --git a/src/_common/decorators/api-paginated.decorator.ts b/src/_common/decorators/api-paginated.decorator.ts
@@ -6,7 +6,9 @@ import { PaginatedFilterDto } from '~/_common/dto/paginated-filter.dto';
 
 export const ApiPaginatedDecorator = <TModel extends Type<NonNullable<unknown>>>(
   model: TModel,
-  options?: ApiResponseOptions | null | undefined,
+  options?: {
+    responseOptions?: ApiResponseOptions | null | undefined,
+  },
 ) => {
   return applyDecorators(
     ApiQuery({ name: 'limit', type: Number, required: false }),
@@ -22,6 +24,6 @@ export const ApiPaginatedDecorator = <TModel extends Type<NonNullable<unknown>>>
         $ref: getSchemaPath(PaginatedFilterDto),
       },
     }),
-    ApiPaginatedResponseDecorator(model, options),
+    ApiPaginatedResponseDecorator(model, { responseOptions: options?.responseOptions }),
   );
 };
diff --git a/src/_common/decorators/api-read-response.decorator.ts b/src/_common/decorators/api-read-response.decorator.ts
@@ -1,12 +1,15 @@
 import { applyDecorators, HttpStatus, Type } from '@nestjs/common';
-import { ApiExtraModels, ApiNotFoundResponse, getSchemaPath } from '@nestjs/swagger';
+import { ApiExtraModels, ApiNotFoundResponse, ApiOperation, ApiOperationOptions, getSchemaPath } from '@nestjs/swagger';
 import { ApiOkResponse, ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator';
 import { NotFoundDto } from '~/_common/dto/not-found.dto';
 
 export const ApiReadResponseDecorator = <TModel extends Type<NonNullable<unknown>>>(
   model: TModel,
-  responseOptions?: ApiResponseOptions | null | undefined,
-  notFoundOptions?: ApiResponseOptions | null | undefined,
+  options?: {
+    responseOptions?: ApiResponseOptions | null | undefined,
+    notFoundOptions?: ApiResponseOptions | null | undefined,
+    operationOptions?: ApiOperationOptions | null | undefined,
+  },
 ) => {
   return applyDecorators(
     ApiExtraModels(model),
@@ -23,14 +26,15 @@ export const ApiReadResponseDecorator = <TModel extends Type<NonNullable<unknown
           },
         },
       },
-      ...responseOptions,
+      ...options?.responseOptions,
     }),
     ApiNotFoundResponse({
       description: 'Item not found',
       schema: {
         $ref: getSchemaPath(NotFoundDto),
       },
-      ...notFoundOptions,
+      ...options?.notFoundOptions,
     }),
+    ApiOperation({ summary: `Récupère l'entrée <${model.name.replace(/Dto$/, '')}> ciblée`, ...options?.operationOptions }),
   );
 };
diff --git a/src/_common/decorators/api-update.decorator.ts b/src/_common/decorators/api-update.decorator.ts
@@ -7,11 +7,13 @@ import { ApiUpdatedResponseDecorator } from '~/_common/decorators/api-updated-re
 export const ApiUpdateDecorator = <TModel extends Type<NonNullable<unknown>>>(
   bodyModel: TModel,
   responseModel: TModel,
-  bodyOptions?: ApiBodyOptions | null | undefined,
-  responseOptions?: ApiResponseOptions | null | undefined,
+  options?: {
+    bodyOptions?: ApiBodyOptions | null | undefined,
+    responseOptions?: ApiResponseOptions | null | undefined,
+  },
 ) => {
   return applyDecorators(
-    ApiBodyDecorator(bodyModel, bodyOptions),
-    ApiUpdatedResponseDecorator(responseModel, responseOptions),
+    ApiBodyDecorator(bodyModel, options?.bodyOptions),
+    ApiUpdatedResponseDecorator(responseModel, { responseOptions: options?.responseOptions }),
   );
 };
diff --git a/src/_common/decorators/api-updated-response.decorator.ts b/src/_common/decorators/api-updated-response.decorator.ts
@@ -1,14 +1,17 @@
 import { applyDecorators, HttpStatus, Type } from '@nestjs/common';
-import { ApiBadRequestResponse, ApiExtraModels, ApiNotFoundResponse, getSchemaPath } from '@nestjs/swagger';
+import { ApiBadRequestResponse, ApiExtraModels, ApiNotFoundResponse, ApiOperation, ApiOperationOptions, getSchemaPath } from '@nestjs/swagger';
 import { ApiOkResponse, ApiResponseOptions } from '@nestjs/swagger/dist/decorators/api-response.decorator';
 import { ErrorSchemaDto } from '~/_common/dto/error-schema.dto';
 import { NotFoundDto } from '~/_common/dto/not-found.dto';
 
 export const ApiUpdatedResponseDecorator = <TModel extends Type<NonNullable<unknown>>>(
   model: TModel,
-  responseOptions?: ApiResponseOptions | null | undefined,
-  badRequestOptions?: ApiResponseOptions | null | undefined,
-  notFoundOptions?: ApiResponseOptions | null | undefined,
+  options?: {
+    responseOptions?: ApiResponseOptions | null | undefined,
+    badRequestOptions?: ApiResponseOptions | null | undefined,
+    notFoundOptions?: ApiResponseOptions | null | undefined,
+    operationOptions?: ApiOperationOptions | null | undefined,
+  },
 ) => {
   return applyDecorators(
     ApiExtraModels(model),
@@ -26,21 +29,22 @@ export const ApiUpdatedResponseDecorator = <TModel extends Type<NonNullable<unkn
           },
         },
       },
-      ...responseOptions,
+      ...options?.responseOptions,
     }),
     ApiBadRequestResponse({
       description: 'Schema validation failed',
       schema: {
         $ref: getSchemaPath(ErrorSchemaDto),
       },
-      ...badRequestOptions,
+      ...options?.badRequestOptions,
     }),
     ApiNotFoundResponse({
       description: 'Item not found',
       schema: {
         $ref: getSchemaPath(NotFoundDto),
       },
-      ...notFoundOptions,
+      ...options?.notFoundOptions,
     }),
+    ApiOperation({ summary: `Mise à jour d'une entrée <${model.name.replace(/Dto$/, '')}>`, ...options?.operationOptions }),
   );
 };
diff --git a/src/app.controller.ts b/src/app.controller.ts
@@ -3,7 +3,7 @@ import { AppService } from './app.service';
 import { Response } from 'express';
 import { AbstractController } from '~/_common/abstracts/abstract.controller';
 import { Public } from './_common/decorators/public.decorator';
-import { ApiBasicAuth, ApiBearerAuth } from '@nestjs/swagger';
+import { ApiBasicAuth, ApiBearerAuth, ApiOperation, ApiResponse } from '@nestjs/swagger';
 
 @Public()
 @Controller()
@@ -15,6 +15,8 @@ export class AppController extends AbstractController {
   }
 
   @Get()
+  @ApiOperation({ summary: 'Get API infos' })
+  @ApiResponse({ status: 200, description: 'Return API infos' })
   public getInfo(@Res() res: Response): Response {
     return res.json({
       ...this.appService.getInfo(),
diff --git a/src/core/agents/agents.controller.ts b/src/core/agents/agents.controller.ts
@@ -1,19 +1,19 @@
 import { Body, Controller, Delete, Get, HttpStatus, Param, Patch, Post, Res } from '@nestjs/common';
-import { AgentsService } from './agents.service';
-import { AbstractController } from '~/_common/abstracts/abstract.controller';
-import { Types } from 'mongoose';
-import { ApiUpdateDecorator } from '~/_common/decorators/api-update.decorator';
 import { ApiParam, ApiTags } from '@nestjs/swagger';
-import { ApiDeletedResponseDecorator } from '~/_common/decorators/api-deleted-response.decorator';
-import { ObjectIdValidationPipe } from '~/_common/pipes/object-id-validation.pipe';
-import { AgentsCreateDto, AgentsDto, AgentsUpdateDto } from '~/core/agents/_dto/agents.dto';
-import { Response } from 'express';
-import { ApiReadResponseDecorator } from '~/_common/decorators/api-read-response.decorator';
-import { PickProjectionHelper } from '~/_common/helpers/pick-projection.helper';
 import { FilterOptions, FilterSchema, SearchFilterOptions, SearchFilterSchema } from '@streamkits/nestjs_module_scrud';
+import { Response } from 'express';
+import { Types } from 'mongoose';
+import { AbstractController } from '~/_common/abstracts/abstract.controller';
 import { ApiCreateDecorator } from '~/_common/decorators/api-create.decorator';
+import { ApiDeletedResponseDecorator } from '~/_common/decorators/api-deleted-response.decorator';
 import { ApiPaginatedDecorator } from '~/_common/decorators/api-paginated.decorator';
+import { ApiReadResponseDecorator } from '~/_common/decorators/api-read-response.decorator';
+import { ApiUpdateDecorator } from '~/_common/decorators/api-update.decorator';
+import { PickProjectionHelper } from '~/_common/helpers/pick-projection.helper';
+import { ObjectIdValidationPipe } from '~/_common/pipes/object-id-validation.pipe';
 import { PartialProjectionType } from '~/_common/types/partial-projection.type';
+import { AgentsCreateDto, AgentsDto, AgentsUpdateDto } from '~/core/agents/_dto/agents.dto';
+import { AgentsService } from './agents.service';
 
 @ApiTags('core/agents')
 @Controller('agents')
diff --git a/src/core/auth/auth.controller.ts b/src/core/auth/auth.controller.ts
@@ -1,6 +1,6 @@
 import { Body, Controller, HttpStatus, Post, Res, UseGuards, Headers, Get } from '@nestjs/common';
 import { Public } from '~/_common/decorators/public.decorator';
-import { ApiTags } from '@nestjs/swagger';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
 import { AbstractController } from '~/_common/abstracts/abstract.controller';
 import { ModuleRef } from '@nestjs/core';
 import { AuthService } from '~/core/auth/auth.service';
@@ -22,6 +22,7 @@ export class AuthController extends AbstractController {
 
   @Post('local')
   @UseGuards(AuthGuard('local'))
+  @ApiOperation({ summary: 'Authentification interne utilisateur' })
   public async authenticateWithLocal(@Res() res: Response, @ReqIdentity() user: AgentType): Promise<Response> {
     const tokens = await this.service.createTokens(user);
     return res.status(HttpStatus.OK).json({
@@ -32,6 +33,7 @@ export class AuthController extends AbstractController {
 
   @Get('session')
   @UseGuards(AuthGuard('jwt'))
+  @ApiOperation({ summary: 'Récupération de la session en cours' })
   public async session(@Res() res: Response, @ReqIdentity() identity: AgentType): Promise<Response> {
     const user = await this.service.getSessionData(identity);
     return res.status(HttpStatus.OK).json({
@@ -44,6 +46,7 @@ export class AuthController extends AbstractController {
 
   //TODO: change any
   @Post('refresh')
+  @ApiOperation({ summary: 'Récupère un nouveau jeton d\'authentification' })
   public async refresh(@Res() res: Response, @Body() body: { refresh_token: string }): Promise<Response> {
     const tokens = await this.service.renewTokens(body.refresh_token);
     return res.status(HttpStatus.OK).json({
@@ -53,6 +56,7 @@ export class AuthController extends AbstractController {
   }
 
   @Post('logout')
+  @ApiOperation({ summary: 'Supprime le jeton d\'authentification utilisateur' })
   public async logout(@Res() res: Response, @Headers('Authorization') jwt: string): Promise<Response> {
     await this.service.clearSession(jwt.replace(/^Bearer\s/, ''));
     return res.status(HttpStatus.OK).send();
