Skip to content

NPA-5136: Standardise Endpoint Errors#228

Merged
LeoKHoward merged 14 commits into
masterfrom
task/NPA-5136/standardise-endpoint-errors
Jul 1, 2025
Merged

NPA-5136: Standardise Endpoint Errors#228
LeoKHoward merged 14 commits into
masterfrom
task/NPA-5136/standardise-endpoint-errors

Conversation

@LeoKHoward

@LeoKHoward LeoKHoward commented Jun 25, 2025 •
edited
Loading

Copy link
Copy Markdown
Contributor

Pull Request

Ticket Link

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

Description/Change Summary

Invalid headers and parameters use different yet similar errors. The error codes are different base on whether APIError class is used or not.

The following errors have been standardised across all endpoints:

  • Missing X-Request-ID
  • Invalid X-Request-ID
  • Invalid X-Correlation-ID

GET /Consent invalid status query parameter:

  • INVALID_VALUE updated to INVALID_PARAMETER

GET /Consent invalid X-IM1-Connection-Params:

  • Updated INVALID_VALUE to INVALID_PARAMETER to align with other errors using INVALID_PARAMETER

How to test?

  • N/A as pvrs repo does not rely on these changes in order to pass

Review Checklist

ℹ️ This section is to be filled in by the reviewer.

  • I have reviewed the changes in this PR and they fill all or part of the acceptance criteria of the ticket, and the code is in a mergeable state.
  • If there were infrastructure, operational, or build changes, I have made sure there is sufficient evidence that the changes will work.
  • I have ensured the changelog has been updated by the submitter, if necessary.

Post-merge

After merging and deploying changes to the sandbox, Postman collection or spec examples please run the Run Postman collection workflow.

This will run the tests within the collection to check that the sandbox is working as expected once deployed.

@github-actions

github-actions Bot commented Jun 25, 2025

Copy link
Copy Markdown

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

NPA-5136

@github-actions

github-actions Bot commented Jun 25, 2025

Copy link
Copy Markdown

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

NPA-5136

@github-actions

github-actions Bot commented Jun 25, 2025

Copy link
Copy Markdown

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

NPA-5136

@github-actions

github-actions Bot commented Jun 25, 2025

Copy link
Copy Markdown

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

NPA-5136

@github-actions

github-actions Bot commented Jun 27, 2025

Copy link
Copy Markdown

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

NPA-5136

@github-actions

github-actions Bot commented Jun 27, 2025

Copy link
Copy Markdown

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

NPA-5136

@LeoKHoward LeoKHoward self-assigned this Jun 27, 2025
@LeoKHoward LeoKHoward added endpoints documentation Improvements or additions to documentation labels Jun 27, 2025
JackPlowman
JackPlowman suggested changes Jun 30, 2025
View reviewed changes
Comment thread specification/examples/responses/GET_Consent/ID/errors/invalid-id.yaml
Comment thread specification/examples/responses/GET_Consent/errors/invalid-status-parameter.yaml Outdated
Comment thread specification/validated-relationships-service-api.yaml
@github-actions

github-actions Bot commented Jun 30, 2025

Copy link
Copy Markdown

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

NPA-5136

JackPlowman
JackPlowman suggested changes Jun 30, 2025
View reviewed changes
Comment thread specification/examples/responses/POST_Consent/errors/invalid_status.yaml
Comment thread specification/validated-relationships-service-api.yaml Outdated
JackPlowman
JackPlowman reviewed Jun 30, 2025
View reviewed changes
Comment thread specification/validated-relationships-service-api.yaml
@github-actions

github-actions Bot commented Jun 30, 2025

Copy link
Copy Markdown

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

NPA-5136

JackPlowman
JackPlowman suggested changes Jun 30, 2025
View reviewed changes

@JackPlowman JackPlowman left a comment

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.

One last issue then ready to approve

Comment thread specification/validated-relationships-service-api.yaml Outdated
@github-actions

github-actions Bot commented Jun 30, 2025

Copy link
Copy Markdown

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

NPA-5136

@LeoKHoward LeoKHoward requested a review from JackPlowman June 30, 2025 14:14
JackPlowman
JackPlowman suggested changes Jun 30, 2025
View reviewed changes
Comment thread specification/validated-relationships-service-api.yaml
@github-actions

github-actions Bot commented Jul 1, 2025

Copy link
Copy Markdown

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

NPA-5136

LeoKHoward added 2 commits July 1, 2025 10:13
@LeoKHoward
NPA-5136: add MISSING_VALUE and INVALID_VALUE to all endpoints
b7b4957
@LeoKHoward
Merge branch 'task/NPA-5136/standardise-endpoint-errors' of github.co…
bd1f022 
…m:NHSDigital/validated-relationships-service-api into task/NPA-5136/standardise-endpoint-errors
@github-actions

github-actions Bot commented Jul 1, 2025

Copy link
Copy Markdown

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

NPA-5136

JackPlowman
JackPlowman suggested changes Jul 1, 2025
View reviewed changes
Comment thread specification/validated-relationships-service-api.yaml Outdated
Comment thread specification/validated-relationships-service-api.yaml Outdated
Comment thread specification/validated-relationships-service-api.yaml Outdated
Comment thread specification/validated-relationships-service-api.yaml Outdated
Comment thread specification/validated-relationships-service-api.yaml Outdated
Comment thread specification/validated-relationships-service-api.yaml Outdated
Comment thread specification/validated-relationships-service-api.yaml Outdated
Comment thread specification/validated-relationships-service-api.yaml Outdated
Comment thread specification/validated-relationships-service-api.yaml Outdated
Comment thread specification/validated-relationships-service-api.yaml Outdated
@github-actions

github-actions Bot commented Jul 1, 2025

Copy link
Copy Markdown

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

NPA-5136

JackPlowman
JackPlowman approved these changes Jul 1, 2025
View reviewed changes

@JackPlowman JackPlowman left a comment

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.

LGTM 👍

@LeoKHoward LeoKHoward merged commit 6d7ca04 into master Jul 1, 2025
17 checks passed
@LeoKHoward LeoKHoward deleted the task/NPA-5136/standardise-endpoint-errors branch July 1, 2025 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@JackPlowman JackPlowman JackPlowman approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@LeoKHoward LeoKHoward

Labels

documentation Improvements or additions to documentation endpoints

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@LeoKHoward @JackPlowman