Skip to content

Commit 74d6a35

Browse files
align README structure with the rest
1 parent 4fe3b42 commit 74d6a35

2 files changed

Lines changed: 5 additions & 1 deletion

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ version.json
1313
# Please, add your custom content below!
1414
.idea
1515
.env
16+
.devcontainer/devcontainer-lock.json
1617

1718
# dependencies
1819
node_modules

lambdas/supplier-mock/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22

33
# Supplier Mock
44

5-
## What is does
5+
## Purpose
66

77
The supplier-mock lambda simulates the supplier's system behaviour so that downstream services can simulate supplier interaction without relying on a live supplier system.
8+
9+
### General Flow
10+
811
The mock simulates the journey of a letter with the Supplier. It utilises the api-handler and retrieves pending letters by calling the `getLetters` lambda directly and then provides status updates for each letter by calling the `patchLetter` lambda.
912
Each time the mock is called it will call `getLetters` once with for the **supplierId** `TestSupplier1` and with a **limit** of `100` letters. These default values can be configured in the AWS Parameter Store as explained in [How to modify parameter store variables](#how-to-modify-default-variable-values-in-parameter-store) . It then loops through each retrieved letter and updates its status by calling `patchLetter` and using the **specification_id_mapping** map to determine its status. If the map doesn't return a value it will default to `ACCEPTED` status.
1013

0 commit comments

Comments
 (0)