Update API decorators with French translations

Author: tacxou

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

@@ -11,6 +11,7 @@ export const ApiBodyDecorator = <TModel extends Type<NonNullable<unknown>>>(
       schema: {
         $ref: getSchemaPath(model),
       },
+      description: 'Corps de création de l\'enregistrement',
       ...options,
     }),
   );

src/_common/decorators/api-created-response.decorator.ts

@@ -25,10 +25,11 @@ export const ApiCreatedResponseDecorator = <TModel extends Type<NonNullable<unkn
           },
         },
       },
+      description: 'L\'enregistrement a été créé avec succès',
       ...options?.responseOptions,
     }),
     ApiBadRequestResponse({
-      description: 'Schema validation failed',
+      description: 'Validation du schéma failed',
       schema: {
         $ref: getSchemaPath(ErrorSchemaDto),
       },

src/_common/decorators/api-deleted-response.decorator.ts

@@ -26,10 +26,11 @@ export const ApiDeletedResponseDecorator = <TModel extends Type<NonNullable<unkn
           },
         },
       },
+      description: 'L\'enregistrement a été supprimé avec succès',
       ...options?.responseOptions,
     }),
     ApiNotFoundResponse({
-      description: 'Item not found',
+      description: 'Impossible de trouver l\'entrée ciblée',
       schema: {
         $ref: getSchemaPath(NotFoundDto),
       },

src/_common/decorators/api-paginated-response.decorator.ts

@@ -31,6 +31,7 @@ export const ApiPaginatedResponseDecorator = <TModel extends Type<any>>(
           },
         ],
       },
+      description: `Liste les entrées <${model.name.replace(/Dto$/, '')}> avec pagination et filtres`,
       ...options?.responseOptions,
     }),
     ApiOperation({ summary: `Liste les entrées <${model.name.replace(/Dto$/, '')}> avec pagination et filtres`, ...options?.operationOptions }),

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

@@ -11,8 +11,24 @@ export const ApiPaginatedDecorator = <TModel extends Type<NonNullable<unknown>>>
   },
 ) => {
   return applyDecorators(
-    ApiQuery({ name: 'limit', type: Number, required: false }),
-    ApiQuery({ name: 'skip', type: Number, required: false }),
+    ApiQuery({
+      name: 'limit',
+      type: Number,
+      required: false,
+      description: 'Limite le nombre d\'éléments retournés',
+    }),
+    ApiQuery({
+      name: 'skip',
+      type: Number,
+      required: false,
+      description: 'Skip les N premiers éléments',
+    }),
+    ApiQuery({
+      name: 'page',
+      type: Number,
+      required: false,
+      description: 'Skip les N premiers éléments en fonction de la limite et de la page (incompatible avec skip)',
+    }),
     ApiExtraModels(PaginatedFilterDto),
     ApiQuery({
       required: false,
@@ -23,6 +39,7 @@ export const ApiPaginatedDecorator = <TModel extends Type<NonNullable<unknown>>>
       schema: {
         $ref: getSchemaPath(PaginatedFilterDto),
       },
+      description: 'Filtres de recherche, voir la documentation de chaque endpoint pour plus de détails',
     }),
     ApiPaginatedResponseDecorator(model, { responseOptions: options?.responseOptions }),
   );

src/_common/decorators/api-read-response.decorator.ts

@@ -26,10 +26,11 @@ export const ApiReadResponseDecorator = <TModel extends Type<NonNullable<unknown
           },
         },
       },
+      description: 'L\'enregistrement a été récupéré avec succès',
       ...options?.responseOptions,
     }),
     ApiNotFoundResponse({
-      description: 'Item not found',
+      description: 'Impossible de trouver l\'entrée ciblée',
       schema: {
         $ref: getSchemaPath(NotFoundDto),
       },

src/_common/decorators/api-updated-response.decorator.ts

@@ -29,17 +29,18 @@ export const ApiUpdatedResponseDecorator = <TModel extends Type<NonNullable<unkn
           },
         },
       },
+      description: 'L\'enregistrement a été mis à jour avec succès',
       ...options?.responseOptions,
     }),
     ApiBadRequestResponse({
-      description: 'Schema validation failed',
+      description: 'Validation du schéma failed',
       schema: {
         $ref: getSchemaPath(ErrorSchemaDto),
       },
       ...options?.badRequestOptions,
     }),
     ApiNotFoundResponse({
-      description: 'Item not found',
+      description: 'Impossible de trouver l\'entrée ciblée',
       schema: {
         $ref: getSchemaPath(NotFoundDto),
       },