Skip to content

Feature/eli 293 oas updates to align with VitA#23

Merged
eddalmond1 merged 9 commits intomainfrom
feature/eli-293-oas-updates-to-align--with-VitA
Jun 18, 2025
Merged

Feature/eli 293 oas updates to align with VitA#23
eddalmond1 merged 9 commits intomainfrom
feature/eli-293-oas-updates-to-align--with-VitA

Conversation

@jhadfield-NHS
Copy link
Contributor

Description

Added new attribute of urlLabel to Actions to carry a label to be used for the link/button.
Updated some links in the description to link to our service page (https://digital.nhs.uk/services/eligibility-data-product-elid)
Revised examples to include changes requested by VitA.
Added specific example cases for errors, to prevent a faulty Postman collection being generated.

Context

Adds required adjustments to examples and content samples to support VitA development.
Corrects previously broken links in specification.

Type of changes

  • Refactoring (non-breaking change)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would change existing functionality)
  • Bug fix (non-breaking change which fixes an issue)

Checklist

  • I am familiar with the contributing guidelines
  • I have followed the code style of the project
  • I have added tests to cover my changes
  • I have updated the documentation accordingly
  • This PR is a result of pair or mob programming

Sensitive Information Declaration

To ensure the utmost confidentiality and protect your and others privacy, we kindly ask you to NOT including PII (Personal Identifiable Information) / PID (Personal Identifiable Data) or any other sensitive data in this PR (Pull Request) and the codebase changes. We will remove any PR that do contain any sensitive information. We really appreciate your cooperation in this matter.

  • I confirm that neither PII/PID nor sensitive data are included in this PR and the codebase changes.

Adjusting examples including description
Updates to some links in the OAS spec description
Re-adding some accidentally removed new-lines
Adding specific examples for error conditions to prevent a Postman collection from being generated with additional values in each array.
Reverting to use a separate field for urlLabel (as requested by VitA) and updating some descriptions to confirm that GFM Markdown can be used
@jhadfield-NHS jhadfield-NHS changed the title Feature/eli 293 oas updates to align with vit a Feature/eli 293 oas updates to align with VitA Jun 17, 2025
Updated to match OAS specification
@jhadfield-NHS jhadfield-NHS requested a review from eddalmond1 June 17, 2025 12:18
@jhadfield-NHS jhadfield-NHS marked this pull request as draft June 17, 2025 15:27
Adding empty action and suitabilityReason arrays to match development of real code
Adding empty actions and suitabilityRules arrays to match developed codebase.
@jhadfield-NHS jhadfield-NHS marked this pull request as ready for review June 17, 2025 15:47
@eddalmond1 eddalmond1 merged commit 88c4645 into main Jun 18, 2025
23 checks passed
@eddalmond1 eddalmond1 deleted the feature/eli-293-oas-updates-to-align--with-VitA branch June 18, 2025 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants