NPA-7384: Update examples and spec to ensure provision.actor is depre…

[ellie-bound1-NHSD]

…cated and not to be used

Pull Request

🧾 Ticket Link

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

---

📄 Description/Summary of Changes

• Make sure provision.actor is labeled as deprecated and remove it from examples.

---

🧪 Developer Testing Carried Out

---

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

[Copilot]

Pull request overview

Updates the OpenAPI specification and example payloads to discourage use of the deprecated Consent.provision.actor field by explicitly marking it deprecated in the spec and removing it from published examples, steering consumers toward policyRule (legal basis) instead.

Changes:

• Mark Provision.actor as deprecated: true in the OpenAPI schema and update its description accordingly.
• Remove provision.actor blocks from many GET/POST example YAMLs.
• Update the PATCH policy rule example’s description (and associated guidance via the example reference).

Reviewed changes

Copilot reviewed 24 out of 24 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
specification/validated-relationships-service-api.yaml	Deprecates Provision.actor in the schema (and updates description text).
specification/examples/responses/GET_Consent/single-mother-child-relationship.yaml	Removes provision.actor from a single-relationship response example.
specification/examples/responses/GET_Consent/single-mother-child-relationship-unknown-legal-basis.yaml	Removes provision.actor from an “unknown legal basis” response example.
specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer.yaml	Removes provision.actor from a response example that includes performer.
specification/examples/responses/GET_Consent/single-mother-child-relationship-include-performer-patient.yaml	Removes provision.actor from a response example that includes performer and patient.
specification/examples/responses/GET_Consent/single-mother-child-relationship-include-patient.yaml	Removes provision.actor from a response example that includes patient.
specification/examples/responses/GET_Consent/single-consenting-adult-relationship.yaml	Removes provision.actor from a single consenting-adult response example.
specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer.yaml	Removes provision.actor from a consenting-adult response example that includes performer.
specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-performer-patient.yaml	Removes provision.actor from a consenting-adult response example that includes performer and patient.
specification/examples/responses/GET_Consent/single-consenting-adult-relationship-include-patient.yaml	Removes provision.actor from a consenting-adult response example that includes patient.
specification/examples/responses/GET_Consent/multiple-relationships.yaml	Removes provision.actor from multiple-relationship response example entries.
specification/examples/responses/GET_Consent/multiple-relationships-single-patient.yaml	Removes provision.actor from multiple-relationship (single patient) response example entries.
specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer.yaml	Removes provision.actor from multiple-relationship (single patient) response example entries including performer.
specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-performer-patient.yaml	Removes provision.actor from multiple-relationship (single patient) response example entries including performer and patient.
specification/examples/responses/GET_Consent/multiple-relationships-single-patient-include-patient.yaml	Removes provision.actor from part of the multiple-relationship (single patient, include patient) response example.
specification/examples/responses/GET_Consent/multiple-relationships-include-performer.yaml	Removes provision.actor from multiple-relationship response example entries including performer.
specification/examples/responses/GET_Consent/multiple-relationships-include-performer-patient.yaml	Removes provision.actor from multiple-relationship response example entries including performer and patient.
specification/examples/responses/GET_Consent/multiple-relationships-include-patient.yaml	Removes provision.actor from multiple-relationship response example entries including patient.
specification/examples/responses/GET_Consent/filtered-relationships-status-proposed-active.yaml	Removes provision.actor from filtered-relationships response example entries.
specification/examples/responses/GET_Consent/filtered-relationships-status-inactive.yaml	Removes provision.actor from the first inactive-status response example entry.
specification/examples/responses/GET_Consent/filtered-relationships-status-active-include-details.yaml	Removes provision.actor blocks (including role/reference) from the include-details example.
specification/examples/requests/POST_Consent/parent_child_proxy_creation.yaml	Removes actor from a POST consent creation request example.
specification/examples/requests/POST_Consent/adult_to_adult_proxy_creation.yaml	Removes actor from a POST consent creation request example.
specification/examples/requests/PATCH_Consent/replace_policy_rule.yaml	Updates the patch example description for changing the legal basis (policyRule).

---

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

[davesmallnhs]

Yup

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud