Skip to content

CCM-20515: switched client-provided URI placeholders to use curly brackets #1087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cgitim wants to merge 6 commits into
base: release
Choose a base branch
from
Open

CCM-20515: switched client-provided URI placeholders to use curly brackets #1087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
23d746a
switched client-provided URI placeholders to use curly brackets
cgitim Jul 17, 2026
db26e43
kick pipeline
cgitim Jul 17, 2026
e8e654f
remove tmp files for sonar
cgitim Jul 20, 2026
b0ca945
replace `{}` in links (Bloomreach adds them)
cgitim Jul 20, 2026
93f5957
include recipient-response in ZAP exclusions (as not in our API)
cgitim Jul 20, 2026
a65f2a9
correction to links in recipient-response schema
cgitim Jul 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions scripts/perform-static-analysis.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
5 changes: 3 additions & 2 deletions scripts/publish_zap_compatible.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,9 @@ def scan_and_remove(obj, mappings):
(
("format", "date"),
("personalisation", None),
("/<client-provided-message-status-URI>", None),
("/<client-provided-channel-status-URI>", None),
("/{client-provided-message-status-URI}", None),

@Ian-Hodges Ian-Hodges Jul 20, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At of curiosity, why has this section been omitted from the scan?

@cgitim cgitim Jul 20, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it's due to angle brackets?

@cgitim cgitim Jul 20, 2026

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apparently they were originally omitted from ZAP because callback URLs are not real scannable endpoints on this API.

("/{client-provided-channel-status-URI}", None),
("/{client-provided-recipient-response-URI}", None),
)
),
f
Expand Down
6 changes: 3 additions & 3 deletions specification/communications-manager.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ paths:
/channels/nhsapp/accounts:
get:
$ref: endpoints/get_nhsapp_account_details.yaml
/<client-provided-message-status-URI>:
/{client-provided-message-status-URI}:
post:
$ref: callbacks/message_status.yaml
tags: ['Callbacks']
/<client-provided-channel-status-URI>:
/{client-provided-channel-status-URI}:
post:
$ref: callbacks/channel_status.yaml
tags: ['Callbacks']
/<client-provided-recipient-response-URI>:
/{client-provided-recipient-response-URI}:
post:
$ref: callbacks/recipient_response.yaml
tags: ['Callbacks']
2 changes: 1 addition & 1 deletion specification/documentation/APIDescription.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions specification/schemas/components/RecipientResponse.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
Loading