NPA-6466: Service Specification Update#312
Merged
Merged
Conversation
- Only include values that are actually returned in OperationOutcome -> code (FHIR error code)
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-6466 |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the OpenAPI specification for the Validated Relationships Service API to narrow the OperationOutcome.issue.code enum to only the codes the service intends to return.
Changes:
- Removed many
OperationOutcome.issue.codeenum values from the spec. - Minor formatting tweak in the
info.descriptionmarkdown block.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ix OperationOutcome expression to be type array, items string
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-6466 |
ClarksonAdam
reviewed
Mar 5, 2026
… intended outcome
|
This branch is work on a ticket in the NHS Digital NPA JIRA Project. Here's a handy link to the ticket: NPA-6466 |
ClarksonAdam
approved these changes
Mar 5, 2026
ClarksonAdam
left a comment
ClarksonAdam
left a comment
Contributor
There was a problem hiding this comment.
Let's get this merged 👍
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Pull Request
🧾 Ticket Link
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
🧪 Reviewer Testing Required
✅ Developer Checklist
NPA-XXXX: <short-description><type>/NPA-XXXX/<short-description>NPA-XXXX: <short-description>terraform,documentation) are added👀 Reviewer Checklist
🚀 Post-merge