Update ApiCreateDecorator to include operationOptions in IdentitiesController

Author: tacxou

src/_common/decorators/api-create.decorator.ts

@@ -1,5 +1,5 @@
 import { applyDecorators, Type } from '@nestjs/common';
-import { ApiBodyOptions } from '@nestjs/swagger';
+import { ApiBodyOptions, ApiOperationOptions } from '@nestjs/swagger';
 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';
@@ -10,10 +10,14 @@ export const ApiCreateDecorator = <TModel extends Type<NonNullable<unknown>>>(
   options?: {
     bodyOptions?: ApiBodyOptions | null | undefined,
     responseOptions?: ApiResponseOptions | null | undefined,
+    operationOptions?: ApiOperationOptions | null | undefined,
   },
 ) => {
   return applyDecorators(
     ApiBodyDecorator(bodyModel, options?.bodyOptions),
-    ApiCreatedResponseDecorator(responseModel, { responseOptions: options?.responseOptions }),
+    ApiCreatedResponseDecorator(responseModel, {
+      responseOptions: options?.responseOptions,
+      operationOptions: options?.operationOptions,
+    }),
   );
 };

src/core/backends/backends.controller.ts

@@ -11,7 +11,7 @@ import {
   Sse,
   UnauthorizedException,
 } from '@nestjs/common';
-import { ApiTags } from '@nestjs/swagger';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
 import { Response } from 'express';
 import Redis from 'ioredis';
 import { Observable, Subscriber } from 'rxjs';
@@ -43,6 +43,7 @@ export class BackendsController {
   ) { }
 
   @Post('sync')
+  @ApiOperation({ summary: 'Synchronise une liste d\'identitées' })
   public async syncIdentities(
     @Res() res: Response,
     @Body() body: SyncIdentitiesDto,
@@ -57,6 +58,7 @@ export class BackendsController {
   }
 
   @Post('syncall')
+  @ApiOperation({ summary: 'Synchronise toutes les identitées à synchroniser' })
   public async syncAllIdentities(@Res() res: Response, @Query('async') asyncQuery: string) {
     const async = /true|on|yes|1/i.test(asyncQuery);
     const data = await this.backendsService.syncAllIdentities({
@@ -66,6 +68,7 @@ export class BackendsController {
   }
 
   @Post('execute')
+  @ApiOperation({ summary: 'Execute un backend manuellement' })
   public async executeJob(
     @Res() res: Response,
     @Body() body: ExecuteJobDto,
@@ -100,6 +103,7 @@ export class BackendsController {
 
   @Public()
   @Sse('sse')
+  @ApiOperation({ summary: 'Server Sent Event - Récupère en temps réel les Jobs et affiche leurs état' })
   public async sse(@Res() res: Response, @Query('key') key: string): Promise<Observable<MessageEvent>> {
     if (key !== 'hZcdVqHScVDsDFdHOdcjmufEKFJVKaS8') throw new UnauthorizedException();
 

src/management/identities/identities.controller.ts

@@ -11,7 +11,7 @@ import {
   Query,
   Res
 } from '@nestjs/common';
-import { ApiParam, ApiTags } from '@nestjs/swagger';
+import { ApiOperation, ApiParam, ApiTags } from '@nestjs/swagger';
 import { FilterOptions, FilterSchema, SearchFilterOptions, SearchFilterSchema } from '@streamkits/nestjs_module_scrud';
 import { Response } from 'express';
 import { Document, Types, isValidObjectId } from 'mongoose';
@@ -83,7 +83,11 @@ export class IdentitiesController extends AbstractController {
   }
 
   @Post('upsert')
-  @ApiCreateDecorator(IdentitiesUpsertDto, IdentitiesDto)
+  @ApiCreateDecorator(IdentitiesUpsertDto, IdentitiesDto, {
+    operationOptions: {
+      summary: 'Importe ou met à jour une <Identitée> en fonction des filtres fournis',
+    },
+  })
   public async upsert(
     @Res()
     res: Response,
@@ -189,6 +193,7 @@ export class IdentitiesController extends AbstractController {
   }
 
   @Get('count')
+  @ApiOperation({ summary: 'Compte le nombre d\'identitées en fonctions des filtres fournis' })
   public async count(
     @Res() res: Response,
     @SearchFilterSchema() searchFilterSchema: FilterSchema,
@@ -239,6 +244,7 @@ export class IdentitiesController extends AbstractController {
   }
 
   @Patch('state')
+  @ApiOperation({ summary: 'Met à jour l\'état d\'une ou plusieurs <Identitées> en masse' })
   public async updateStateMany(
     @Res() res: Response,
     @Body()

src/management/identities/jsonforms/identities.jsonforms.controller.ts

@@ -2,7 +2,7 @@ import { Body, Controller, Get, HttpStatus, Param, Post, Res } from '@nestjs/com
 import { AbstractController } from '~/_common/abstracts/abstract.controller';
 import { IdentitiesJsonformsService } from './identities.jsonforms.service';
 import { Response } from 'express';
-import { ApiTags } from '@nestjs/swagger'
+import { ApiOperation, ApiTags } from '@nestjs/swagger'
 
 @ApiTags('management/identities/jsonforms')
 @Controller('management/identities/jsonforms')
@@ -12,6 +12,7 @@ export class IdentitiesJsonFormsController extends AbstractController {
   }
 
   @Post('generateAll')
+  @ApiOperation({ summary: 'Génère tous les JSON Forms liés aux schémas personnalisés' })
   async generateAll(@Res() res: Response): Promise<any> {
     const result = await this._service.generateAll();
     return res.status(HttpStatus.OK).json({
@@ -21,6 +22,7 @@ export class IdentitiesJsonFormsController extends AbstractController {
   }
 
   @Post('generate')
+  @ApiOperation({ summary: 'Génère un JSON Forms d\'un schéma personnalisé' })
   async generate(@Res() res: Response, @Body('schema') schema: string | null = null): Promise<any> {
     const result = await this._service.generate({ schema, path: './configs/identities/jsonforms' });
     return res.status(HttpStatus.OK).json({
@@ -30,6 +32,7 @@ export class IdentitiesJsonFormsController extends AbstractController {
   }
 
   @Get()
+  @ApiOperation({ summary: 'Liste les JSON Forms de schémas personnalisés' })
   async searchAll(@Res() res: Response): Promise<any> {
     const result = await this._service.findAll();
     return res.status(HttpStatus.OK).json({
@@ -39,6 +42,7 @@ export class IdentitiesJsonFormsController extends AbstractController {
   }
 
   @Get(':schema')
+  @ApiOperation({ summary: 'Récupère un JSON Forms d\'un schéma personnalisé' })
   async search(@Res() res: Response, @Param('schema') schema): Promise<any> {
     const result = await this._service.findOne(schema);
     return res.status(HttpStatus.OK).json({

src/management/identities/validations/identities.validation.controller.ts

@@ -1,6 +1,6 @@
 import { Body, Controller, Get, HttpStatus, Param, Post, Res } from '@nestjs/common';
 import { AbstractController } from '~/_common/abstracts/abstract.controller';
-import { ApiTags } from '@nestjs/swagger';
+import { ApiOperation, ApiTags } from '@nestjs/swagger';
 import { Response } from 'express';
 import { MixedValue } from '~/_common/types/mixed-value.type';
 import { AdditionalFieldsPart } from '../_schemas/_parts/additionalFields.part.schema';
@@ -14,6 +14,7 @@ export class IdentitiesValidationController extends AbstractController {
   }
 
   @Post()
+  @ApiOperation({ summary: 'Effectue la validation des schémas personnalisés d\'identités' })
   public async validate(
     @Res()
     res: Response,
@@ -45,6 +46,7 @@ export class IdentitiesValidationController extends AbstractController {
   }
 
   @Get()
+  @ApiOperation({ summary: 'Liste les schémas personnalisés d\'identités' })
   async searchAll(@Res() res: Response): Promise<any> {
     const result = await this._service.findAll();
     return res.status(HttpStatus.OK).json({
@@ -54,6 +56,7 @@ export class IdentitiesValidationController extends AbstractController {
   }
 
   @Get(':schema')
+  @ApiOperation({ summary: 'Récupère un schéma personnalisé d\'identités' })
   async search(@Res() res: Response, @Param('schema') schema): Promise<any> {
     const result = await this._service.findOne(schema);
     return res.status(HttpStatus.OK).json({

src/management/passwd/passwd.controller.ts

@@ -15,21 +15,18 @@ export class PasswdController {
   public constructor(private passwdService: PasswdService) { }
 
   @Post('change')
-  @ApiOperation({ summary: 'Change password' })
-  @ApiResponse({ status: HttpStatus.OK, description: 'Password has been successfully changed.' })
-  @ApiResponse({ status: HttpStatus.BAD_REQUEST, description: 'Old password wrong' })
+  @ApiOperation({ summary: 'Execute un job de changement de mot de passe sur le/les backends' })
+  @ApiResponse({ status: HttpStatus.OK, description: 'Mot de passe synchronisé sur le/les backends' })
   public async change(@Body() body: ChangePasswordDto, @Res() res: Response): Promise<Response> {
-    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const [_, data] = await this.passwdService.change(body);
     this.logger.log(`Call passwd change for : ${body.uid}`);
 
     return res.status(HttpStatus.OK).json(data);
   }
 
   @Post('gettoken')
-  @ApiOperation({ summary: 'Ask token for reseting password' })
-  @ApiResponse({ status: HttpStatus.OK, description: 'Token' })
-  @ApiResponse({ status: HttpStatus.BAD_REQUEST })
+  @ApiOperation({ summary: 'Récupère un jeton de réinitialisation de mot de passe' })
+  @ApiResponse({ status: HttpStatus.OK, description: 'Retourne un jeton de réinitialisation de mot de passe' })
   public async gettoken(@Body() asktoken: AskTokenDto, @Res() res: Response): Promise<Response> {
     this.logger.log('GetToken for : ' + asktoken.uid);
     const token = await this.passwdService.askToken(asktoken);
@@ -38,9 +35,8 @@ export class PasswdController {
   }
 
   @Post('verifytoken')
-  @ApiOperation({ summary: 'Ask token for reseting password' })
+  @ApiOperation({ summary: 'Vérifie un jeton de réinitilisation de mot de passe' })
   @ApiResponse({ status: HttpStatus.OK })
-  @ApiResponse({ status: HttpStatus.BAD_REQUEST })
   public async verifyToken(@Body() body: VerifyTokenDto, @Res() res: Response): Promise<Response> {
     this.logger.log('Verify token : ' + body.token);
     const data = await this.passwdService.decryptToken(body.token);
@@ -49,9 +45,8 @@ export class PasswdController {
   }
 
   @Post('reset')
-  @ApiOperation({ summary: 'Reset password' })
+  @ApiOperation({ summary: 'Execute un job de réinitialisation de mot de passe sur le/les backends' })
   @ApiResponse({ status: HttpStatus.OK })
-  @ApiResponse({ status: HttpStatus.BAD_REQUEST })
   public async reset(@Body() body: ResetPasswordDto, @Res() res: Response): Promise<Response> {
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const [_, data] = await this.passwdService.reset(body);