Releases: NHSDigital/validated-relationships-service-api
Releases · NHSDigital/validated-relationships-service-api
v1.0.537-alpha
npm (deps-dev): bump tar-fs from 2.1.3 to 2.1.4 (#270) Bumps [tar-fs](https://github.com/mafintosh/tar-fs) from 2.1.3 to 2.1.4. <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/mafintosh/tar-fs/commit/f421a235565b6a6d305bdf87e999ebdfae9dd1cc"><code>f421a23</code></a> 2.1.4</li> <li><a href="https://github.com/mafintosh/tar-fs/commit/c412fa130e216d4c01392f6fb62c8725c1a4ac8b"><code>c412fa1</code></a> refactor to same pattern as v3</li> <li>See full diff in <a href="https://github.com/mafintosh/tar-fs/compare/v2.1.3...v2.1.4">compare view</a></li> </ul> </details> <br /> [](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores) You can trigger a rebase of this PR by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) You can disable automated security fix PRs for this repo from the [Security Alerts page](https://github.com/NHSDigital/validated-relationships-service-api/network/alerts). </details> > **Note** > Automatic rebases have been disabled on this pull request as it has been open for over 30 days. Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: tomknapp <tomknapp@users.noreply.github.com>
v1.0.536-alpha
NPA-6466: Service Specification Update (#312) - Only include values that are actually returned in OperationOutcome -> code (FHIR error code) # Pull Request ## 🧾 Ticket Link [NPA-6466](https://nhsd-jira.digital.nhs.uk/browse/NPA-6466) --- ## 📄 Description/Summary of Changes API Specification amended to remove codes that are never returned from the service in a OperationOutcome object -> code enum --- ## 🧪 Developer Testing Carried Out All schema tests run to test example success and error responses against the spec - from project root: ```zsh make schema-all ``` --- ## 🧪 Reviewer Testing Required --- ## ✅ Developer Checklist <!-- Complete before submitting the PR --> - [x] PR title follows the format: `NPA-XXXX: <short-description>` - [x] Branch name follows the convention: `<type>/NPA-XXXX/<short-description>` - [x] Commit messages follow the template: `NPA-XXXX: <short-description>` - [x] All acceptance criteria from the Jira ticket are addressed - [ ] Automated tests (unit/integration/API/infrastructure etc. tests) are added or updated - [ ] Assignees and appropriate labels (e.g. `terraform`, `documentation`) are added --- ## 👀 Reviewer Checklist <!-- To be completed by the reviewer --> - [ ] Changes meet the acceptance criteria of the Jira ticket - [ ] Code is able to be merged (no conflicts and adheres to coding standards) - [ ] Sufficient test evidence is provided (manual and/or automated) - [ ] Infrastructure/operational/build changes are validated (if applicable) --- ## 🚀 Post-merge
v1.0.535-alpha
NPA-6347: OAS Spec version bump (#309) # Pull Request ## 🧾 Ticket Link <!-- Add the Jira ticket link here --> https://nhsd-jira.digital.nhs.uk/browse/NPA-6347 --- ## 📄 Description/Summary of Changes <!-- Describe the changes made in this PR. Include the purpose/scope/impact of the changes --> - OAS spec version bump for next [release](https://nhsd-jira.digital.nhs.uk/projects/NPA/versions/67575) --- ## 🧪 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 --> - N/A --- ## 🧪 Reviewer Testing Required <!-- Describe how to test the changes that have been made in the ticket. Include: --> <!-- - Testing environment details (e.g. sandbox/local setup) --> <!-- - Steps to verify the changes --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> --- ## ✅ Developer Checklist <!-- Complete before submitting the PR --> - [ ] 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>` - [ ] All acceptance criteria from the Jira ticket are addressed - [ ] Automated tests (unit/integration/API/infrastructure etc. tests) are added or updated - [ ] Assignees and appropriate labels (e.g. `terraform`, `documentation`) are added --- ## 👀 Reviewer Checklist <!-- To be completed by the reviewer --> - [ ] Changes meet the acceptance criteria of the Jira ticket - [ ] Code is able to be merged (no conflicts and adheres to coding standards) - [ ] Sufficient test evidence is provided (manual and/or automated) - [ ] Infrastructure/operational/build changes are validated (if applicable) --- ## 🚀 Post-merge <!-- Actions to complete after merging --> 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.
v1.0.534-alpha
NPA-6153: Grantor Updated HTTP To HTTPS (#305) # Pull Request ## 🧾 Ticket Link <!-- Add the Jira ticket link here --> https://nhsd-jira.digital.nhs.uk/browse/NPA-6153 --- ## 📄 Description/Summary of Changes <!-- Describe the changes made in this PR. Include the purpose/scope/impact of the changes --> - Updated HTTP url for grantor to HTTPS --- ## 🧪 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 --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> --- ## 🧪 Reviewer Testing Required <!-- Describe how to test the changes that have been made in the ticket. Include: --> <!-- - Testing environment details (e.g. sandbox/local setup) --> <!-- - Steps to verify the changes --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> --- ## ✅ Developer Checklist <!-- Complete before submitting the PR --> - [x] PR title follows the format: `NPA-XXXX: <short-description>` - [x] Branch name follows the convention: `<type>/NPA-XXXX/<short-description>` - [x] Commit messages follow the template: `NPA-XXXX: <short-description>` - [x] All acceptance criteria from the Jira ticket are addressed - [x] Automated tests (unit/integration/API/infrastructure etc. tests) are added or updated - [x] Assignees and appropriate labels (e.g. `terraform`, `documentation`) are added --- ## 👀 Reviewer Checklist <!-- To be completed by the reviewer --> - [ ] Changes meet the acceptance criteria of the Jira ticket - [ ] Code is able to be merged (no conflicts and adheres to coding standards) - [ ] Sufficient test evidence is provided (manual and/or automated) - [ ] Infrastructure/operational/build changes are validated (if applicable) --- ## 🚀 Post-merge <!-- Actions to complete after merging --> 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.
v1.0.533-alpha
NPA-5882: Auto generate sandbox postman collection (#307) # Pull Request ## 🧾 Ticket Link <!-- Add the Jira ticket link here --> https://nhsd-jira.digital.nhs.uk/browse/NPA-5882 --- ## 📄 Description/Summary of Changes <!-- Describe the changes made in this PR. Include the purpose/scope/impact of the changes --> - New make commands to generate sandbox postman collection and test collection using newman - Added new dependencies - Update github actions to generate sandbox postman collection -> run sandbox locally -> test new collection against new local sandbox -> commit changes to branch - Now link to postman is instruction to import 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 --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> --- ## 🧪 Reviewer Testing Required <!-- Describe how to test the changes that have been made in the ticket. Include: --> <!-- - Testing environment details (e.g. sandbox/local setup) --> <!-- - Steps to verify the changes --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> --- ## ✅ Developer Checklist <!-- Complete before submitting the PR --> - [ ] 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>` - [ ] All acceptance criteria from the Jira ticket are addressed - [ ] Automated tests (unit/integration/API/infrastructure etc. tests) are added or updated - [ ] Assignees and appropriate labels (e.g. `terraform`, `documentation`) are added --- ## 👀 Reviewer Checklist <!-- To be completed by the reviewer --> - [ ] Changes meet the acceptance criteria of the Jira ticket - [ ] Code is able to be merged (no conflicts and adheres to coding standards) - [ ] Sufficient test evidence is provided (manual and/or automated) - [ ] Infrastructure/operational/build changes are validated (if applicable) --- ## 🚀 Post-merge <!-- Actions to complete after merging --> 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.
v1.0.532-alpha
NPA-6402: Initial Commit (#303)
## Description/Summary of Changes
<!-- NPA-6402: Consent:grantee - Patient for Proxy -->
# Pull Request
## 🧾 Ticket Link
<!-- Add the Jira ticket link here -->
https://nhsd-jira.digital.nhs.uk/browse/NPA-6402
This PR updates the sandbox API, OAS specification, example YAML
responses, Postman collections, and tests to replace
`_include=Consent:performer` with `_include=Consent:grantee`. When
`_include=Consent:grantee` is used, the response now returns a
**Patient** resource for the proxy (containing their demographic
information) and a **RelatedPerson** resource for the relationship,
rather than only returning a RelatedPerson resource for the proxy as was
previously the case with `Consent:performer`.
This change addresses the issue where Proxy Role Related Persons may not
exist in PDS (e.g. when a GP sets up a proxy role via NPS for a carer).
By returning proxy details via a Patient resource, VRS avoids the
scenario where PDS returns a 404 for a non-existent RelatedPerson, which
would previously cause VRS to return an error.
- Renamed `_include` parameter value from `Consent:performer` to
`Consent:grantee` across the sandbox API code (`constants.py`,
`utils.py`, `get_consent.py`, `get_consent_by_id.py`)
- Updated all YAML example response files in both
`sandbox/api/examples/` and `specification/examples/responses/` to
reflect the new `Consent:grantee` include behaviour, with grantee
includes now returning a Patient resource for the proxy and a
RelatedPerson resource for the relationship
- Renamed example files from `*-include-performer*` to
`*-include-grantee*` naming convention
- Removed old `Consent:performer` example files that are no longer
needed
- Updated the OAS specification
(`validated-relationships-service-api.yaml`) to document
`Consent:grantee` as the valid include parameter value, including
descriptions, scenario tables, example references, and enum definitions
- Updated both Postman collections (sandbox and integration) to use
`Consent:grantee` in place of `Consent:performer`
- Updated all sandbox unit tests to use `Consent:grantee` parameter
values and reference the renamed example files
---
## Developer Testing Carried Out
- All 103 sandbox unit tests pass (`cd sandbox && python -m pytest
api/tests/ -v`)
- Tests cover both `GET /Consent` and `GET /Consent/{id}` endpoints with
`_include=Consent:grantee`, `_include=Consent:patient`, and both
combined
- Tests verify correct example YAML files are returned for each
combination of query parameters including `performer:identifier`,
`patient:identifier`, and `_include` params
- Tests cover error scenarios (invalid include params returning 422,
internal server errors)
- Verified YAML example responses contain the correct resource types:
Consent (match), Patient for proxy (include), RelatedPerson for
relationship (include), and Patient for patient (include)
---
## Reviewer Testing Required
- Clone the branch and run sandbox tests: `cd sandbox && python -m
pytest api/tests/ -v` - all 103 tests should pass
- Start the sandbox locally and verify the following scenarios against
the OAS spec scenario tables:
- `GET
/Consent?performer:identifier=9000000010&_include=Consent:grantee`
returns a Bundle with the Consent resource and a Patient resource for
the proxy
- `GET
/Consent?performer:identifier=9000000010&_include=Consent:grantee&_include=Consent:patient`
returns a Bundle with the Consent, Patient (proxy), RelatedPerson
(relationship), and Patient (patient) resources
- `GET /Consent/{id}?_include=Consent:grantee` returns the expected
included resources for both consenting adult
(`74eed847-ca25-4e76-8cf2-f2c2d7842a7a`) and mother-child
(`39df03a2-1b14-4d19-b1dc-d5d8cbf96948`) scenarios
- `GET
/Consent?performer:identifier=9000000022&_include=Consent:grantee`
returns multiple relationships with proxy Patient resources included
- Invalid `_include` values (e.g. `_include=Consent:performer`) return
HTTP 422 with an INVALID_PARAMETER error
- Import the updated Postman sandbox collection and verify requests
using `Consent:grantee` return expected responses
- Review the OAS specification renders correctly and the scenario
tables, parameter enums, and example references all reflect
`Consent:grantee`
---
## ✅ Developer Checklist
<!-- Complete before submitting the PR -->
- [x] PR title follows the format: `NPA-XXXX: <short-description>`
- [x] Branch name follows the convention:
`<type>/NPA-XXXX/<short-description>`
- [x] Commit messages follow the template: `NPA-XXXX:
<short-description>`
- [x] All acceptance criteria from the Jira ticket are addressed
- [x] Automated tests (unit/integration/API/infrastructure etc. tests)
are added or updated
- [ ] Assignees and appropriate labels (e.g. `terraform`,
`documentation`) are added
---
## 👀 Reviewer Checklist
<!-- To be completed by the reviewer -->
- [ ] Changes meet the acceptance criteria of the Jira ticket
- [ ] Code is able to be merged (no conflicts and adheres to coding
standards)
- [ ] Sufficient test evidence is provided (manual and/or automated)
- [ ] Infrastructure/operational/build changes are validated (if
applicable)
---
## 🚀 Post-merge
<!-- Actions to complete after merging -->
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.
v1.0.531-alpha
NPA-6376: Content Review (#298) # Pull Request ## 🧾 Ticket Link <!-- Add the Jira ticket link here --> https://nhsd-jira.digital.nhs.uk/browse/NPA-6376 --- ## 📄 Description/Summary of Changes <!-- Describe the changes made in this PR. Include the purpose/scope/impact of the changes --> - No changes.. But place for comments to be added --- ## 🧪 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 --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> --- ## 🧪 Reviewer Testing Required <!-- Describe how to test the changes that have been made in the ticket. Include: --> <!-- - Testing environment details (e.g. sandbox/local setup) --> <!-- - Steps to verify the changes --> - [ ] <!-- Add bullet points for testing instructions --> - [ ] <!-- Add bullet points for testing instructions --> - [ ] <!-- Add bullet points for testing instructions --> --- ## ✅ Developer Checklist <!-- Complete before submitting the PR --> - [ ] 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>` - [ ] All acceptance criteria from the Jira ticket are addressed - [ ] Automated tests (unit/integration/API/infrastructure etc. tests) are added or updated - [ ] Assignees and appropriate labels (e.g. `terraform`, `documentation`) are added --- ## 👀 Reviewer Checklist <!-- To be completed by the reviewer --> - [ ] Changes meet the acceptance criteria of the Jira ticket - [ ] Code is able to be merged (no conflicts and adheres to coding standards) - [ ] Sufficient test evidence is provided (manual and/or automated) - [ ] Infrastructure/operational/build changes are validated (if applicable) --- ## 🚀 Post-merge <!-- Actions to complete after merging --> 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. --------- Co-authored-by: adamclarkson <adam.clarkson1@nhs.net>
v1.0.530-alpha
NPA-6153: Create Update Proxy Role Grantor Field Two (#301) # Pull Request ## 🧾 Ticket Link <!-- Add the Jira ticket link here --> https://nhsd-jira.digital.nhs.uk/browse/NPA-6153 --- ## 📄 Description/Summary of Changes <!-- Describe the changes made in this PR. Include the purpose/scope/impact of the changes --> - Added all errors to both post and patch consent endpoints - Updated sandbox files - Updated postman files --- ## 🧪 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 --> - Postman tests pass --- ## 🧪 Reviewer Testing Required <!-- Describe how to test the changes that have been made in the ticket. Include: --> <!-- - Testing environment details (e.g. sandbox/local setup) --> <!-- - Steps to verify the changes --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> --- ## ✅ Developer Checklist <!-- Complete before submitting the PR --> - [x] PR title follows the format: `NPA-XXXX: <short-description>` - [x] Branch name follows the convention: `<type>/NPA-XXXX/<short-description>` - [x] Commit messages follow the template: `NPA-XXXX: <short-description>` - [x] All acceptance criteria from the Jira ticket are addressed - [x] Automated tests (unit/integration/API/infrastructure etc. tests) are added or updated - [x] Assignees and appropriate labels (e.g. `terraform`, `documentation`) are added --- ## 👀 Reviewer Checklist <!-- To be completed by the reviewer --> - [ ] Changes meet the acceptance criteria of the Jira ticket - [ ] Code is able to be merged (no conflicts and adheres to coding standards) - [ ] Sufficient test evidence is provided (manual and/or automated) - [ ] Infrastructure/operational/build changes are validated (if applicable) --- ## 🚀 Post-merge <!-- Actions to complete after merging --> 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. --------- Co-authored-by: ChristopherBacon <59895399+ChristopherBacon@users.noreply.github.com> Co-authored-by: ChristopherBacon <christopher.bacon1@nhs.net>
v1.0.529-alpha
NPA-6154: Change the spec and Postman (#299) # Pull Request ## 🧾 Ticket Link <!-- Add the Jira ticket link here --> https://nhsd-jira.digital.nhs.uk/browse/NPA-6154 --- ## 📄 Description/Summary of Changes <!-- Describe the changes made in this PR. Include the purpose/scope/impact of the changes --> - Update Postman - Update Spec - <!-- Add bullet points summarising key changes --> --- ## 🧪 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 --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> - <!-- Add bullet points for testing instructions --> --- ## 🧪 Reviewer Testing Required <!-- Describe how to test the changes that have been made in the ticket. Include: --> <!-- - Testing environment details (e.g. sandbox/local setup) --> <!-- - Steps to verify the changes --> - [ ] <!-- Add bullet points for testing instructions --> - [ ] <!-- Add bullet points for testing instructions --> - [ ] <!-- Add bullet points for testing instructions --> --- ## ✅ Developer Checklist <!-- Complete before submitting the PR --> - [x] PR title follows the format: `NPA-XXXX: <short-description>` - [x] Branch name follows the convention: `<type>/NPA-XXXX/<short-description>` - [x] Commit messages follow the template: `NPA-XXXX: <short-description>` - [ ] All acceptance criteria from the Jira ticket are addressed - [ ] Automated tests (unit/integration/API/infrastructure etc. tests) are added or updated - [ ] Assignees and appropriate labels (e.g. `terraform`, `documentation`) are added --- ## 👀 Reviewer Checklist <!-- To be completed by the reviewer --> - [ ] Changes meet the acceptance criteria of the Jira ticket - [ ] Code is able to be merged (no conflicts and adheres to coding standards) - [ ] Sufficient test evidence is provided (manual and/or automated) - [ ] Infrastructure/operational/build changes are validated (if applicable) --- ## 🚀 Post-merge <!-- Actions to complete after merging --> 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. --------- Co-authored-by: Leo Howard <38526889+LeoKHoward@users.noreply.github.com>
v1.0.528-alpha
NPA-6154: Update the date for the postman collections