Skip to content

Releases: NHSDigital/validated-relationships-service-api

v1.0.572-alpha

Choose a tag to compare

@github-actions github-actions released this 14 Jul 09:04
e130035
NPA-7004: Update Status Reason Codes (#370)

# Pull Request

## 🧾 Ticket Link

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

---

## 📄 Description/Summary of Changes

Removed from spec:
- APPLICATION_REJECTED_COERCION
- ROLE_DEACTIVATED_FAMILIAL_REASON

Renamed in spec:
- APPLICATION_REJECTED_PROXY_ABROAD (Proxy lives abroad) to
APPLICATION_REJECTED_PROXY_NOT_LIVING_IN_ENGLAND_OR_WALES (Proxy not
living in England or Wales)
- ROLE_DEACTIVATED_PROXY_ABROAD (Proxy lives abroad) to
ROLE_DEACTIVATED_PROXY_NOT_LIVING_IN_ENGLAND_OR_WALES (Proxy not living
in England or Wales)

---

## 🧪 Developer Testing Carried Out

Using `make localdev-preview-spec` on LOCALDEV, inspected the HTML spec.

**Before changes:**

- ROLE_DEACTIVATED_FAMILIAL_REASON, APPLICATION_REJECTED_COERCION,
ROLE_DEACTIVATED_PROXY_ABROAD and APPLICATION_REJECTED_PROXY_ABROAD all
exist in spec

<img width="780" height="875" alt="Screenshot 2026-07-10 at 11 15 50"
src="https://github.com/user-attachments/assets/4d704c3f-7134-4f8f-850c-7e4a7bbddf8d"
/>

**After changes:***

- ROLE_DEACTIVATED_FAMILIAL_REASON and APPLICATION_REJECTED_COERCION
have gone away.
- ROLE_DEACTIVATED_PROXY_ABROAD and APPLICATION_REJECTED_PROXY_ABROAD
have changed to ENGLAND_OR_WALES
- 
<img width="780" height="875" alt="image"
src="https://github.com/user-attachments/assets/da5bcc25-d015-4c97-9f3a-10c5b32f38b7"
/>

---

## 📋 PR Principles

<!-- Principles we as a team follow when conducting a PR -->

- 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>`

v1.0.571-alpha

Choose a tag to compare

@github-actions github-actions released this 15 Jun 09:41
9d79d02
NPA-6955: Version bump v1.25.0 (#360)

# Pull Request

## 🧾 Ticket Link

<!-- Add the Jira ticket link here -->

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

---

## 📄 Description/Summary of Changes

<!-- Describe the changes made in this PR. Include the
purpose/scope/impact of the changes -->

- Spec version bump

---

## 🧪 Developer Testing Carried Out

<!-- Describe what tests (automated/unit/manual etc.) have been done for
the ticket. Include: -->
<!-- - Any tests added/updated -->
<!-- - Evidence that each acceptance criterion from the Jira ticket is
met -->
<!-- - Evidence of tests running eg. link to github workflow with tests
passing or screenshot of tests running locally -->

- <!-- Briefly describe the testing carried out in this PR -->

---

## 📋 PR Principles

<!-- Principles we as a team follow when conducting a PR -->

- 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>`

v1.0.570-alpha

Choose a tag to compare

@github-actions github-actions released this 12 Jun 12:37
457d0f2
NPA-6896: Add Valid Status Reason Codes and Legal Basis Values to Spe…

v1.0.569-alpha

Choose a tag to compare

@github-actions github-actions released this 09 Jun 14:56
355364f
NPA-6940: bump spec version (#359)

# Pull Request

## 🧾 Ticket Link

<!-- Add the Jira ticket link here -->

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

---

## 📄 Description/Summary of Changes

<!-- Describe the changes made in this PR. Include the
purpose/scope/impact of the changes -->

- Bump spec version before release
---

## 🧪 Developer Testing Carried Out

<!-- Describe what tests (automated/unit/manual etc.) have been done for
the ticket. Include: -->
<!-- - Any tests added/updated -->
<!-- - Evidence that each acceptance criterion from the Jira ticket is
met -->
<!-- - Evidence of tests running eg. link to github workflow with tests
passing or screenshot of tests running locally -->

- Build passing, the existing bug that APIM pointed out making Azure not
report to GitHub properly
<img width="1609" height="80" alt="image"
src="https://github.com/user-attachments/assets/c0046185-1914-41f2-9905-747212f2dca8"
/>


---

## 📋 PR Principles

<!-- Principles we as a team follow when conducting a PR -->

- 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>`

v1.0.568-alpha

Choose a tag to compare

@github-actions github-actions released this 09 Jun 10:42
bbcf855
NPA-6883: Add Notify as Related API in OAS Spec  (#358)

# Pull Request

## 🧾 Ticket Link

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

---

## 📄 Description/Summary of Changes

- Added link to **NHS Notify API** in **Related APIs**
- Added new make command to preview
`validated-relationships-service-api.yaml` on LOCALDEV.
- `make localdev-preview-spec` builds NHS-styled API documentation using
RapiDoc, matching digital.nhs.uk layout
- It builds JSON and HTML versions of the spec locally in the `build`
directory and previews the HTML in a web browser
- This should give developers more confidence in the impact of their
changes

---

## 🧪 Developer Testing Carried Out

- The LOCALDEV preview is close (but not exactly the same) as the live
version at
https://digital.nhs.uk/developer/api-catalogue/validated-relationship-service.
It shows the link to **NHS Notify API**:

<img width="1240" height="407" alt="image"
src="https://github.com/user-attachments/assets/6b88964e-a054-45c2-9a9d-1d93d073820d"
/>

---

## 📋 PR Principles

<!-- Principles we as a team follow when conducting a PR -->

- 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>`

v1.0.567-alpha

Choose a tag to compare

@github-actions github-actions released this 09 Jun 09:38
d80c7f2
NPA-6897: Add Correlation ID, Request ID and Authorization request he…

v1.0.566-alpha

Choose a tag to compare

@github-actions github-actions released this 03 Jun 12:20
e019098
NPA-6879: Add RPN as Related API in OAS Spec (#355)

# Pull Request

## 🧾 Ticket Link

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

---

## 📄 Description/Summary of Changes

- Single line text addition

---

## 🧪 Developer Testing Carried Out

- None
- 
---

## 📋 PR Principles

<!-- Principles we as a team follow when conducting a PR -->

- 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>`

v1.0.565-alpha

Choose a tag to compare

@github-actions github-actions released this 27 May 16:41
4f5fc80
Fix: Remove postman collection INT link (#354)

# Pull Request

## 🧾 Ticket Link

<!-- Add the Jira ticket link here -->

No ticket for this change

---

## 📄 Description/Summary of Changes

<!-- Describe the changes made in this PR. Include the
purpose/scope/impact of the changes -->

- Removed the link in the API spec for the INT postman collection

---

## 🧪 Developer Testing Carried Out

<!-- Describe what tests (automated/unit/manual etc.) have been done for
the ticket. Include: -->
<!-- - Any tests added/updated -->
<!-- - Evidence that each acceptance criterion from the Jira ticket is
met -->
<!-- - Evidence of tests running eg. link to github workflow with tests
passing or screenshot of tests running locally -->

---

## 📋 PR Principles

<!-- Principles we as a team follow when conducting a PR -->

- 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>`

v1.0.564-alpha

Choose a tag to compare

@github-actions github-actions released this 26 May 16:13
e29c6b4
NPA-6807: increment spec version for release (#353)

# Pull Request

## 🧾 Ticket Link

<!-- Add the Jira ticket link here -->

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

## 📄 Description/Summary of Changes

<!-- Describe the changes made in this PR. Include the
purpose/scope/impact of the changes -->

- Increment spec version ahead of VRSA release

---

## 🧪 Developer Testing Carried Out

<!-- Describe what tests (automated/unit/manual etc.) have been done for
the ticket. Include: -->
<!-- - Any tests added/updated -->
<!-- - Evidence that each acceptance criterion from the Jira ticket is
met -->
<!-- - Evidence of tests running eg. link to github workflow with tests
passing or screenshot of tests running locally -->

- <!-- Briefly describe the testing carried out in this PR -->

---

## 📋 PR Principles

<!-- Principles we as a team follow when conducting a PR -->

- 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>`

v1.0.563-alpha

Choose a tag to compare

@github-actions github-actions released this 21 May 13:49
acb5588
NPA-6800: Update PR check in each repo to fail on High severity rathe…