Clean up

Author: francisco-videira-nhs

infrastructure/terraform/components/api/module_lambda_get_letters.tf

@@ -2,7 +2,7 @@ module "get_letters" {
   source = "git::https://github.com/NHSDigital/nhs-notify-shared-modules.git//infrastructure/modules/lambda?ref=v2.0.10"
 
   function_name = "get_letters"
-  description   = "Get some letters ids"
+  description   = "Get paginated letter ids"
 
   aws_account_id = var.aws_account_id
   component      = var.component

infrastructure/terraform/components/api/resources/spec.tmpl.json

@@ -55,7 +55,7 @@
     },
     "/letters": {
       "get": {
-        "description": "Returns 200 OK with some letter ids.",
+        "description": "Returns 200 OK with paginated letter ids.",
         "responses": {
           "200": {
             "description": "OK"

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

@@ -20,7 +20,7 @@ export const getLetters: Handler = async (event: APIGatewayProxyEvent): Promise<
   };
 };
 
-interface Link {
+interface GetLettersLinks {
   self: string;
   first: string;
   last: string;
@@ -34,7 +34,7 @@ interface Resource {
 }
 
 interface GetLettersResponse {
-  links: Link;
+  links: GetLettersLinks;
   data: Resource[];
 }