From 23d746a346a75bfbf143cfe01283c709ac96edde Mon Sep 17 00:00:00 2001 From: Tim Marston Date: Fri, 17 Jul 2026 12:16:49 +0100 Subject: [PATCH 1/6] switched client-provided URI placeholders to use curly brackets --- scripts/publish_zap_compatible.py | 4 ++-- specification/communications-manager.yaml | 6 +++--- specification/documentation/APIDescription.md | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/scripts/publish_zap_compatible.py b/scripts/publish_zap_compatible.py index f9bd467da..bd5391bb7 100644 --- a/scripts/publish_zap_compatible.py +++ b/scripts/publish_zap_compatible.py @@ -42,8 +42,8 @@ def scan_and_remove(obj, mappings): ( ("format", "date"), ("personalisation", None), - ("/", None), - ("/", None), + ("/{client-provided-message-status-URI}", None), + ("/{client-provided-channel-status-URI}", None), ) ), f diff --git a/specification/communications-manager.yaml b/specification/communications-manager.yaml index 5c2979ad8..4ab713263 100644 --- a/specification/communications-manager.yaml +++ b/specification/communications-manager.yaml @@ -35,15 +35,15 @@ paths: /channels/nhsapp/accounts: get: $ref: endpoints/get_nhsapp_account_details.yaml - /: + /{client-provided-message-status-URI}: post: $ref: callbacks/message_status.yaml tags: ['Callbacks'] - /: + /{client-provided-channel-status-URI}: post: $ref: callbacks/channel_status.yaml tags: ['Callbacks'] - /: + /{client-provided-recipient-response-URI}: post: $ref: callbacks/recipient_response.yaml tags: ['Callbacks'] diff --git a/specification/documentation/APIDescription.md b/specification/documentation/APIDescription.md index b103572a0..c7b6d0ab7 100644 --- a/specification/documentation/APIDescription.md +++ b/specification/documentation/APIDescription.md @@ -253,7 +253,7 @@ Answer options: [Yes, No] In order to present the recipient with answers, include the `answerOptions` field. -If you subscribe to recipient response callbacks, NHS Notify will send you a callback when a recipient responds to a message (currently only NHS App supports this). See [the recipient response callback](#post-/) for more details. +If you subscribe to recipient response callbacks, NHS Notify will send you a callback when a recipient responds to a message (currently only NHS App supports this). See [the recipient response callback](#post-/{client-provided-recipient-response-URI}) for more details. ## Message character limits Different character limits apply to each of the communication channels as listed below. NHS Notify will validate that any personalisation fields submitted in the send message request do not exceed these limits but it is the client's responsibility to ensure that when personalisation is combined with any templated text, the channel character limit is not exceeded. From db26e43d1465e00cef9fc3cbff9e53b258bc8a6d Mon Sep 17 00:00:00 2001 From: Tim Marston Date: Fri, 17 Jul 2026 16:39:32 +0100 Subject: [PATCH 2/6] kick pipeline From e8e654f82f1741981096c301f3df46ee14db434b Mon Sep 17 00:00:00 2001 From: Tim Marston Date: Mon, 20 Jul 2026 14:06:52 +0100 Subject: [PATCH 3/6] remove tmp files for sonar --- scripts/perform-static-analysis.sh | 2 ++ 1 file changed, 2 insertions(+) diff --git a/scripts/perform-static-analysis.sh b/scripts/perform-static-analysis.sh index 452b37d00..4aaf66ec0 100755 --- a/scripts/perform-static-analysis.sh +++ b/scripts/perform-static-analysis.sh @@ -30,6 +30,8 @@ function main() { function create-report() { + rm -rf sandbox/coverage/tmp + docker run --rm --platform linux/amd64 \ --volume $PWD:/usr/src \ sonarsource/sonar-scanner-cli:$image_version \ From b0ca945adec8b239d8ae8e010df0d45fafe26a6d Mon Sep 17 00:00:00 2001 From: Tim Marston Date: Mon, 20 Jul 2026 14:09:54 +0100 Subject: [PATCH 4/6] replace `{}` in links (Bloomreach adds them) Co-authored-by: Ian Hodges --- specification/documentation/APIDescription.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/documentation/APIDescription.md b/specification/documentation/APIDescription.md index c7b6d0ab7..c4a24db72 100644 --- a/specification/documentation/APIDescription.md +++ b/specification/documentation/APIDescription.md @@ -253,7 +253,7 @@ Answer options: [Yes, No] In order to present the recipient with answers, include the `answerOptions` field. -If you subscribe to recipient response callbacks, NHS Notify will send you a callback when a recipient responds to a message (currently only NHS App supports this). See [the recipient response callback](#post-/{client-provided-recipient-response-URI}) for more details. +If you subscribe to recipient response callbacks, NHS Notify will send you a callback when a recipient responds to a message (currently only NHS App supports this). See [the recipient response callback](#post-/-client-provided-recipient-response-URI-) for more details. ## Message character limits Different character limits apply to each of the communication channels as listed below. NHS Notify will validate that any personalisation fields submitted in the send message request do not exceed these limits but it is the client's responsibility to ensure that when personalisation is combined with any templated text, the channel character limit is not exceeded. From 93f59579713911ff9e158a32e0486cf50b8fb6ac Mon Sep 17 00:00:00 2001 From: Tim Marston Date: Mon, 20 Jul 2026 14:16:56 +0100 Subject: [PATCH 5/6] include recipient-response in ZAP exclusions (as not in our API) --- scripts/publish_zap_compatible.py | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/publish_zap_compatible.py b/scripts/publish_zap_compatible.py index bd5391bb7..075ab987c 100644 --- a/scripts/publish_zap_compatible.py +++ b/scripts/publish_zap_compatible.py @@ -44,6 +44,7 @@ def scan_and_remove(obj, mappings): ("personalisation", None), ("/{client-provided-message-status-URI}", None), ("/{client-provided-channel-status-URI}", None), + ("/{client-provided-recipient-response-URI}", None), ) ), f From a65f2a95cccdb2fa6796b15c2f3e11e862087ef8 Mon Sep 17 00:00:00 2001 From: Tim Marston Date: Mon, 20 Jul 2026 15:39:44 +0100 Subject: [PATCH 6/6] correction to links in recipient-response schema --- specification/schemas/components/RecipientResponse.yaml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/schemas/components/RecipientResponse.yaml b/specification/schemas/components/RecipientResponse.yaml index ea1ea49ed..a8e42cac8 100644 --- a/specification/schemas/components/RecipientResponse.yaml +++ b/specification/schemas/components/RecipientResponse.yaml @@ -69,13 +69,13 @@ properties: links: type: object properties: - recipientResponse: + messageResponses: type: string description: URL to retrieve the recipient response details. format: uri - example: "https://api.service.nhs.uk/comms/v1/messages/2WL3qFTEFM0qMY8xjRbt1LIKCzM/recipient-response/33333333-3333-4333-8333-333333333333" + example: "https://api.service.nhs.uk/comms/v1/message-responses/2WL3qFTEFM0qMY8xjRbt1LIKCzM" required: - - recipientResponse + - messageResponses meta: type: object properties: