NPA-6425: auditing error responses by ehallam · Pull Request #319 · NHSDigital/validated-relationships-service-api

ehallam · 2026-03-12T15:34:56Z

Pull Request

🧾 Ticket Link

https://nhsd-jira.digital.nhs.uk/browse/NPA-6425

📄 Description/Summary of Changes

This PR matches up the error responses we return from VRS with the Spec.
This involved some error codes changing, and some errors being added/removed
A PR has been raised in the PVRS repo to reflect some of these changes too.

🧪 Developer Testing Carried Out

Tested this spec branch against my PVRS changes to check all tests passing https://github.com/NHSDigital/proxy-validated-relationships-service/pull/1392

📋 PR Principles

Keep PRs Small and Focused: Ensure the PR addresses a single task or feature to make it easier to review.
Multiple PRs for one Ticket: When splitting work into multiple PRs, clearly describe what this PR addresses and outline the remaining work to complete the ticket.
Ensure Tests Are Included: Add or update unit, integration, or end-to-end tests to cover the changes made.
Follow Coding Standards: Ensure the code adheres to the team's coding guidelines and best practices.
Resolve Comments Promptly: If you raise a comment, ensure you follow up and resolve it before approving the PR to maintain clarity and ensure comments are addressed.
Foster Learning: PR reviews are an opportunity to share knowledge, provide constructive feedback, and encourage a collaborative environment.

🏷️ Naming Conventions Reminder

Please ensure the following naming conventions are followed:

PR title follows the format: NPA-XXXX: <short-description>
Branch name follows the convention: <type>/NPA-XXXX/<short-description>
Commit messages follow the template: NPA-XXXX: <short-description>

…ry proxy roles and so forth

…down

github-actions · 2026-03-12T15:35:14Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6425

github-actions · 2026-03-12T15:35:38Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6425

github-actions · 2026-03-12T16:22:35Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6425

github-actions · 2026-03-13T10:31:34Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6425

github-actions · 2026-03-13T13:16:40Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6425

github-actions · 2026-03-13T13:23:54Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6425

github-actions · 2026-03-13T13:37:48Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6425

github-actions · 2026-03-13T13:44:32Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6425

ellie-bound1-NHSD

Looks good - just left one comment

ellie-bound1-NHSD · 2026-03-17T10:30:41Z

specification/validated-relationships-service-api.yaml

            | HTTP status | Error code                 | Description                                                  |
            | ----------- | -------------------------- | ------------------------------------------------------------ |
-            | 500         | `SERVER_ERROR`             | An unexpected internal server error has occurred.            |
+            | 500         | `SERVER_ERROR`             | An unexpected internal server error has occurred.  (Could be possible? there is a generic try catch that returns an APIError object with whatever error it gets thrown)          |


Please remove the question note here

github-actions · 2026-03-17T10:59:23Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6425

github-actions · 2026-03-17T11:02:11Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6425

github-actions · 2026-03-17T11:23:17Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6425

github-actions · 2026-03-18T09:09:19Z

This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket:

NPA-6425

ellie-bound1-NHSD · 2026-03-17T10:34:18Z

specification/validated-relationships-service-api.yaml

            | 404         | `INVALIDATED_RESOURCE`             | Resource that has been marked as invalid was requested - invalid resources cannot be retrieved                                            |
            | 405         | `METHOD_NOT_ALLOWED`               | The method is not allowed.                                                                                                                |
            | 408         | `TIMEOUT`                          | Request timed out.                                                                                                                        |
+            | 422         | `INVALID_IDENTIFIER_SYSTEM`        | Invalid identifier system.                                                                                                                |


Why change the status code here? I think 400 should remain?

ehallam added 7 commits March 11, 2026 11:14

NPA-6425: POST /QuestionnaireResponse done

77286e2

NPA-6425: audited 5xx error codes

c37f58f

NPA-6425: audited error responses for get QuestionnaireResponse

d9a4515

NPA-6425: get related person endpoint errors audited

4634a61

NPA-6425: done get consented relationships lambda, still need the que…

8882cb0

…ry proxy roles and so forth

NPA-6425: added error codes to post consent, still need to trim them …

ed00fd5

…down

NPA-6425: update consent endpoint audited

ec3e3b3

Merge branch 'master' into task/NPA-6425/auditing-error-responses

1bd9d6d

NPA-6425: filtered down create consent errors

e953dc3

NPA-6425: finished auditing errors

00b3c5f

ehallam added 2 commits March 13, 2026 10:47

NPA-6425: formatting the table

c60ca61

NPA-6425: final tidy up of spec

03d2d34

NPA-6425: removed leftover comment

e037867

NPA-6425: removed random apostrophe

f38eaf7

NPA-6425: reverted NOT FOUND error correction

18ebcc4

ehallam marked this pull request as ready for review March 16, 2026 11:41

ellie-bound1-NHSD reviewed Mar 17, 2026

View reviewed changes

NPA-6425: removed comment

f8d2092

NPA-6425: removed test-report.xml

de2fbce

NPA-6425: added test-report.xml to gitignore

9f5be89

NPA-6425: reverted the relevant 422 statuses back to 400

31c863f

ellie-bound1-NHSD approved these changes Mar 18, 2026

View reviewed changes

ehallam merged commit aff1bb1 into master Mar 18, 2026
17 checks passed

ehallam deleted the task/NPA-6425/auditing-error-responses branch March 18, 2026 10:29

Conversation

ehallam commented Mar 12, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request

🧾 Ticket Link

📄 Description/Summary of Changes

🧪 Developer Testing Carried Out

📋 PR Principles

🏷️ Naming Conventions Reminder

Uh oh!

github-actions bot commented Mar 12, 2026

Uh oh!

github-actions bot commented Mar 12, 2026

Uh oh!

github-actions bot commented Mar 12, 2026

Uh oh!

github-actions bot commented Mar 13, 2026

Uh oh!

github-actions bot commented Mar 13, 2026

Uh oh!

github-actions bot commented Mar 13, 2026

Uh oh!

github-actions bot commented Mar 13, 2026

Uh oh!

github-actions bot commented Mar 13, 2026

Uh oh!

ellie-bound1-NHSD left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Mar 17, 2026

Uh oh!

github-actions bot commented Mar 17, 2026

Uh oh!

github-actions bot commented Mar 17, 2026

Uh oh!

github-actions bot commented Mar 18, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

ehallam commented Mar 12, 2026 •

edited

Loading