NPA-5757: update schema for status and status reason description

[ChristopherBacon]

Pull Request

🧾 Ticket Link

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

---

📄 Description/Summary of Changes

• Updated the examples and description for the PATCH /Consent/{id} endpoint to specify to supply statusReason along with status

---

🧪 Developer Testing Carried Out

• Checked Swagger editor as docs changed

---

🧪 Reviewer Testing Required

---

✅ Developer Checklist

• 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

• 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

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]

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

NPA-5757

[ChristopherBacon]

Image from Swagger editor for description:

[ellie-bound1-NHSD]

Looking good
Thinking we should update the example for postman collection as at mo status reason is TBC
https://github.com/NHSDigital/validated-relationships-service-api/blob/master/specification/examples/requests/PATCH_Consent/replace_status.yaml

[github-actions]

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

NPA-5757

[github-actions]

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

NPA-5757

[github-actions]

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

NPA-5757

[github-actions]

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

NPA-5757