CCM-11602: Rename size parameter to limit

Author: simonlabarere

internal/datastore/src/letter-repository.ts

@@ -132,13 +132,13 @@ export class LetterRepository {
     return LetterSchema.parse(result.Attributes);
   }
 
-  async getLettersBySupplier(supplierId: string, status: string, size: number): Promise<LetterBase[]> {
+  async getLettersBySupplier(supplierId: string, status: string, limit: number): Promise<LetterBase[]> {
     const supplierStatus = `${supplierId}#${status}`;
     const result = await this.ddbClient.send(new QueryCommand({
       TableName: this.config.lettersTableName,
       IndexName: 'supplierStatus-index',
       KeyConditionExpression: 'supplierStatus = :supplierStatus',
-      Limit: size,
+      Limit: limit,
       ExpressionAttributeNames: {
         '#status': 'status' // reserved keyword
       },

lambdas/api-handler/src/handlers/get-letters.ts

@@ -24,16 +24,16 @@ export const getLetters: APIGatewayProxyHandler = async (event) => {
     // The endpoint should only return pending letters for now
     const status = "PENDING";
 
-    let size = event.queryStringParameters?.size;
+    let limit = event.queryStringParameters?.limit;
 
-    if (!size) {
-      size = "10";
+    if (!limit) {
+      limit = "10";
     }
 
     const letters = await getLettersForSupplier(
       supplierId,
       status,
-      Number(size),
+      Number(limit),
       letterRepo,
     );
 
@@ -42,7 +42,7 @@ export const getLetters: APIGatewayProxyHandler = async (event) => {
     log.info({
       description: 'Pending letters successfully fetched',
       supplierId,
-      size,
+      limit,
       status,
       lettersCount: letters.length
     });

lambdas/api-handler/src/services/letter-operations.ts

@@ -4,9 +4,9 @@ import { LetterApiResource, LetterApiDocument } from '../contracts/letter-api';
 import { toApiLetter } from '../mappers/letter-mapper';
 
 
-export const getLettersForSupplier = async (supplierId: string, status: string, size: number, letterRepo: LetterRepository): Promise<LetterBase[]> => {
+export const getLettersForSupplier = async (supplierId: string, status: string, limit: number, letterRepo: LetterRepository): Promise<LetterBase[]> => {
 
-  return await letterRepo.getLettersBySupplier(supplierId, status, size);
+  return await letterRepo.getLettersBySupplier(supplierId, status, limit);
 }
 
 export const patchLetterStatus = async (letterToUpdate: LetterApiResource, letterId: string, supplierId: string, letterRepo: LetterRepository): Promise<LetterApiDocument> => {

sandbox/api/openapi.yaml

@@ -45,10 +45,10 @@ paths:
           type: string
         style: simple
       - description: |-
-          Size of the page to fetched.
+          Limit maximum number of items to be fetched
         explode: true
         in: query
-        name: size
+        name: limit
         required: false
         schema:
           example: 10