Fix indentation

Author: wildjames

SAMtemplates/apis/main.yaml

@@ -564,47 +564,47 @@ Resources:
       Timeout: "1"
       Count: 0
 
-    NotificationsReportingResource:
-      Condition: ShouldDeployNotificationsReporting
-      Type: AWS::ApiGateway::Resource
-      Properties:
-        RestApiId: !Ref RestApiGateway
-        ParentId: !GetAtt RestApiGateway.RootResourceId
-        PathPart: notifications-reporting
-
-    NotificationsReportingMethod:
-      Condition: ShouldDeployNotificationsReporting
-      Type: AWS::ApiGateway::Method
-      Properties:
-        RestApiId: !Ref RestApiGateway
-        ResourceId: !Ref NotificationsReportingResource
-        HttpMethod: GET
-        AuthorizationType: NONE
-        Integration:
-          Type: AWS_PROXY
-          Credentials: !GetAtt RestApiGatewayResources.Outputs.ApiGwRoleArn
-          IntegrationHttpMethod: POST
-          Uri: !Sub arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${NotificationsReportingFunctionArn}/invocations
-
-    NotificationsReportingHandle:
-      Condition: ShouldDeployNotificationsReporting
-      DependsOn: NotificationsReportingMethod
-      Type: "AWS::CloudFormation::WaitConditionHandle"
-
-    NotificationsReportingWaitHandle:
-      Type: "AWS::CloudFormation::WaitConditionHandle"
-
-    NotificationsReportingWaitCondition:
-      Type: "AWS::CloudFormation::WaitCondition"
-      Properties:
-        Handle:
-          !If [
-            ShouldDeployNotificationsReporting,
-            !Ref NotificationsReportingHandle,
-            !Ref NotificationsReportingWaitHandle,
-          ]
-        Timeout: "1"
-        Count: 0
+  NotificationsReportingResource:
+    Condition: ShouldDeployNotificationsReporting
+    Type: AWS::ApiGateway::Resource
+    Properties:
+      RestApiId: !Ref RestApiGateway
+      ParentId: !GetAtt RestApiGateway.RootResourceId
+      PathPart: notifications-reporting
+
+  NotificationsReportingMethod:
+    Condition: ShouldDeployNotificationsReporting
+    Type: AWS::ApiGateway::Method
+    Properties:
+      RestApiId: !Ref RestApiGateway
+      ResourceId: !Ref NotificationsReportingResource
+      HttpMethod: GET
+      AuthorizationType: NONE
+      Integration:
+        Type: AWS_PROXY
+        Credentials: !GetAtt RestApiGatewayResources.Outputs.ApiGwRoleArn
+        IntegrationHttpMethod: POST
+        Uri: !Sub arn:aws:apigateway:${AWS::Region}:lambda:path/2015-03-31/functions/${NotificationsReportingFunctionArn}/invocations
+
+  NotificationsReportingHandle:
+    Condition: ShouldDeployNotificationsReporting
+    DependsOn: NotificationsReportingMethod
+    Type: "AWS::CloudFormation::WaitConditionHandle"
+
+  NotificationsReportingWaitHandle:
+    Type: "AWS::CloudFormation::WaitConditionHandle"
+
+  NotificationsReportingWaitCondition:
+    Type: "AWS::CloudFormation::WaitCondition"
+    Properties:
+      Handle:
+        !If [
+          ShouldDeployNotificationsReporting,
+          !Ref NotificationsReportingHandle,
+          !Ref NotificationsReportingWaitHandle,
+        ]
+      Timeout: "1"
+      Count: 0
 
   # *********************************************************************
   # if you add a new endpoint, then change the name of this resource

packages/notificationsReportingLambda/README.md

@@ -0,0 +1,92 @@
+# Notifications reporting lambda
+
+This lambda exposes a lightweight, internal reporting endpoint for notification status records stored in the notifications DynamoDB table.
+
+## Overview
+
+- **API path**: `GET /notifications-reporting`
+- **Purpose**: return notification status records for troubleshooting and test reporting.
+- **Data source**: the notifications table (`PrescriptionNotificationStatesTableName`).
+- **Deployment**: controlled by the `DeployNotificationsReporting` parameter.
+
+## Request
+
+Query parameters (at least one is required):
+
+- `prescriptionId` (string)
+- `nhsNumber` (string)
+- `odsCode` (string)
+
+Notes:
+
+- `odsCode` is upper‑cased before querying.
+- If `nhsNumber` is provided, the lambda performs a **query** by partition key and applies additional filters.
+- If only `prescriptionId` and/or `odsCode` are provided, the lambda performs a **scan** using those filters.
+
+### Example
+
+```
+GET /notifications-reporting?nhsNumber=9999999999&odsCode=A12345
+```
+
+## Response
+
+Success (200):
+
+```json
+{
+  "count": 2,
+  "filters": {
+    "prescriptionId": null,
+    "odsCode": "A12345",
+    "nhsNumberProvided": true
+  },
+  "notifications": [
+    {
+      "NHSNumber": "9999999999",
+      "ODSCode": "A12345",
+      "RequestId": "req-1",
+      "PrescriptionID": "RX123",
+      "LastNotifiedPrescriptionStatus": "DELIVERED",
+      "LastNotificationRequestTimestamp": "2025-01-01T10:00:00.000Z",
+      "ExpiryTime": 1735735200,
+      "NotifyMessageReference": "ref-1",
+      "MessageStatus": "delivered",
+      "SupplierStatus": "delivered"
+    }
+  ]
+}
+```
+
+Error responses:
+
+- **400** when no filters are provided.
+- **500** for unexpected failures reading DynamoDB.
+
+## Data flow
+
+```mermaid
+sequenceDiagram
+  autonumber
+  actor Client
+  participant APIGW as API Gateway
+  participant Lambda as NotificationsReporting Lambda
+  participant DynamoDB as Notifications Table
+
+  Client->>APIGW: GET /notifications-reporting?filters
+  APIGW->>Lambda: Invoke (event)
+  Lambda->>Lambda: Normalize filters
+  alt No filters
+    Lambda-->>APIGW: 400 {message}
+    APIGW-->>Client: 400
+  else Filters present
+    alt nhsNumber provided
+      Lambda->>DynamoDB: Query by NHSNumber + filters
+    else no nhsNumber
+      Lambda->>DynamoDB: Scan by filters
+    end
+    DynamoDB-->>Lambda: Items
+    Lambda-->>APIGW: 200 {count, filters, notifications}
+    APIGW-->>Client: 200
+  end
+```