CCM-11580: Updates for OAS Spec V1 by m-houston · Pull Request #139 · NHSDigital/nhs-notify-supplier-api

m-houston · 2025-09-03T15:29:16Z

Description

Updates and fixes to the main OAS spec closing in on V1

Remove GET endpoints for MI
Remove paging from GET /letters
Moved GET /letter-data to GET /letters/{id}/data
Fix various OAS syntax issues

Context

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.

Remove 'requestedProductionStatus' from letter-related JSON schemas and update examples to singular form CCM-11580: Update serve-oas command CCM-11580: Update serve-oas command CCM-11580: Remove unneeded endpoints and resource types + Move getData endpoint under letter CCM-11580: Remove hello world endpoint CCM-11580: Remove hello world endpoint CCM-11580: Add sandbox handler metadata to endpoints CCM-11580: More fixes to examples syntax CCM-11580: Remove remaining reference to hello-world lambda CCM-11580: Remove remaining reference to hello-world lambda CCM-11580: add limit parameter to list letters endpoint CCM-11580: Update sandbox endpoints to match OAS CCM-11580: Update letter responses in Sandbox to match spec changes CCM-11580: implement get letter status endpoint in sandbox Add groupId to schema and examples

# Conflicts: # infrastructure/terraform/components/api/README.md # infrastructure/terraform/components/api/locals.tf # infrastructure/terraform/components/api/module_lambda_hello_world.tf

sonarqubecloud · 2025-09-09T16:39:37Z

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

* CCM-11580: OAS syntax fixes Remove 'requestedProductionStatus' from letter-related JSON schemas and update examples to singular form CCM-11580: Update serve-oas command CCM-11580: Update serve-oas command CCM-11580: Remove unneeded endpoints and resource types + Move getData endpoint under letter CCM-11580: Remove hello world endpoint CCM-11580: Remove hello world endpoint CCM-11580: Add sandbox handler metadata to endpoints CCM-11580: More fixes to examples syntax CCM-11580: Remove remaining reference to hello-world lambda CCM-11580: Remove remaining reference to hello-world lambda CCM-11580: add limit parameter to list letters endpoint CCM-11580: Update sandbox endpoints to match OAS CCM-11580: Update letter responses in Sandbox to match spec changes CCM-11580: implement get letter status endpoint in sandbox Add groupId to schema and examples * CCM-11580: remove x-eov extension from non sandox spec --------- Co-authored-by: mark.slowey1 <mark.slowey1@nhs.net>

* CCM-11580: OAS syntax fixes Remove 'requestedProductionStatus' from letter-related JSON schemas and update examples to singular form CCM-11580: Update serve-oas command CCM-11580: Update serve-oas command CCM-11580: Remove unneeded endpoints and resource types + Move getData endpoint under letter CCM-11580: Remove hello world endpoint CCM-11580: Remove hello world endpoint CCM-11580: Add sandbox handler metadata to endpoints CCM-11580: More fixes to examples syntax CCM-11580: Remove remaining reference to hello-world lambda CCM-11580: Remove remaining reference to hello-world lambda CCM-11580: add limit parameter to list letters endpoint CCM-11580: Update sandbox endpoints to match OAS CCM-11580: Update letter responses in Sandbox to match spec changes CCM-11580: implement get letter status endpoint in sandbox Add groupId to schema and examples * CCM-11580: remove x-eov extension from non sandox spec --------- Co-authored-by: mark.slowey1 <mark.slowey1@nhs.net> Signed-off-by: Namitha-Prabhu <namitha.prabhu@cgi.com>

remove escape char remove files remove files rebase main Signed-off-by: Namitha-Prabhu <namitha.prabhu@cgi.com> CCM-11580: Updates for OAS Spec V1 (#139) * CCM-11580: OAS syntax fixes Remove 'requestedProductionStatus' from letter-related JSON schemas and update examples to singular form CCM-11580: Update serve-oas command CCM-11580: Update serve-oas command CCM-11580: Remove unneeded endpoints and resource types + Move getData endpoint under letter CCM-11580: Remove hello world endpoint CCM-11580: Remove hello world endpoint CCM-11580: Add sandbox handler metadata to endpoints CCM-11580: More fixes to examples syntax CCM-11580: Remove remaining reference to hello-world lambda CCM-11580: Remove remaining reference to hello-world lambda CCM-11580: add limit parameter to list letters endpoint CCM-11580: Update sandbox endpoints to match OAS CCM-11580: Update letter responses in Sandbox to match spec changes CCM-11580: implement get letter status endpoint in sandbox Add groupId to schema and examples * CCM-11580: remove x-eov extension from non sandox spec --------- Co-authored-by: mark.slowey1 <mark.slowey1@nhs.net> Signed-off-by: Namitha-Prabhu <namitha.prabhu@cgi.com> remove files Signed-off-by: Namitha-Prabhu <namitha.prabhu@cgi.com> remove reference to zsh. Signed-off-by: Namitha-Prabhu <namitha.prabhu@cgi.com>

* CCM-11602: Test * CCM-11602: letters schema * CCM-11602: letters schema * CCM-11602: Give get letters access to GSI * CCM-11602: GET Letters endpoint * CCM-11602: GET Letters endpoint * CCM-11602: GET Letters endpoint * CCM-11602: GET Letters endpoint * CCM-11602: GET Letters endpoint * CCM-11602: GET Endpoint sandbox updates * CCM-11602: Get enpoint tests * CCM-11602: Get enpoint safe header check * CCM-11602: Update sandbox * CCM-11602: Update sandbox * CCM-11602: Add logging * CCM-11602: Update sandbox * CCM-11602: Rename size parameter to limit * CCM-11602: Add validation for limit parameter * CCM-11602: increase Trivy scan timeout * CCM-11602: Add groupId * Correct target URL for main (#134) * CCM-11942 Fixing cross repo workflows (#137) * CCM-11942 Fixing cross repo workflows * CCM-11942 Fixing cross repo workflows * CCM-11942 Fixing cross repo workflows * CCM-11751: Use github release assests for shared modules call (#142) * CCM-11751: Use github release assests for shared modules call * CCM-11751: Use github release assests for shared modules call * CCM-11751: Use github release assests for shared modules call * CCM-11751: Use github release assests for shared modules call * CCM-11751: Fixing workflow trigger (#146) * CCM-11580: Updates for OAS Spec V1 (#139) * CCM-11580: OAS syntax fixes Remove 'requestedProductionStatus' from letter-related JSON schemas and update examples to singular form CCM-11580: Update serve-oas command CCM-11580: Update serve-oas command CCM-11580: Remove unneeded endpoints and resource types + Move getData endpoint under letter CCM-11580: Remove hello world endpoint CCM-11580: Remove hello world endpoint CCM-11580: Add sandbox handler metadata to endpoints CCM-11580: More fixes to examples syntax CCM-11580: Remove remaining reference to hello-world lambda CCM-11580: Remove remaining reference to hello-world lambda CCM-11580: add limit parameter to list letters endpoint CCM-11580: Update sandbox endpoints to match OAS CCM-11580: Update letter responses in Sandbox to match spec changes CCM-11580: implement get letter status endpoint in sandbox Add groupId to schema and examples * CCM-11580: remove x-eov extension from non sandox spec --------- Co-authored-by: mark.slowey1 <mark.slowey1@nhs.net> * Update README.md (#140) Small change to fix Sonar cloud badges * Add timestamp value to supplierStatusSk * CCM-11602: param validation, max range, and OAS 400 examples * CCM-11602: unit test expectation wording * CCM-11602: MAX LIMIT envar and added into test context * CCM-11602: limit can't be 0, return maxLimit value --------- Co-authored-by: David Wass <david.wass2@nhs.net> Co-authored-by: Aiden Vaines <54067008+aidenvaines-cgi@users.noreply.github.com> Co-authored-by: sidnhs <siddharth.nair1@nhs.net> Co-authored-by: Mike Houston <60653100+m-houston@users.noreply.github.com> Co-authored-by: mark.slowey1 <mark.slowey1@nhs.net> Co-authored-by: Tim Ireland <tim.ireland@hscic.gov.uk> Co-authored-by: Mark Slowey <113013138+masl2@users.noreply.github.com> Co-authored-by: Francisco Videira <francisco.videira@nhs.net>

m-houston requested review from a team as code owners September 3, 2025 15:29

m-houston marked this pull request as draft September 3, 2025 15:38

simonlabarere previously approved these changes Sep 4, 2025

View reviewed changes

m-houston dismissed simonlabarere’s stale review via de2dae3 September 4, 2025 13:31

m-houston force-pushed the feature/CCM-11580-oas-spec-v1 branch from cce4998 to 84e756e Compare September 4, 2025 16:28

masl2 previously approved these changes Sep 9, 2025

View reviewed changes

masl2 marked this pull request as ready for review September 9, 2025 14:34

masl2 dismissed their stale review via e1ddd45 September 9, 2025 14:40

masl2 previously approved these changes Sep 9, 2025

View reviewed changes

sidnhs previously approved these changes Sep 9, 2025

View reviewed changes

aidenvaines-cgi previously approved these changes Sep 9, 2025

View reviewed changes

m-houston dismissed stale reviews from aidenvaines-cgi, sidnhs, and masl2 via d0a2f66 September 9, 2025 15:40

m-houston force-pushed the feature/CCM-11580-oas-spec-v1 branch from e1ddd45 to d0a2f66 Compare September 9, 2025 15:40

m-houston and others added 2 commits September 9, 2025 16:43

Merge branch 'main' into feature/CCM-11580-oas-spec-v1

40bdb87

# Conflicts: # infrastructure/terraform/components/api/README.md # infrastructure/terraform/components/api/locals.tf # infrastructure/terraform/components/api/module_lambda_hello_world.tf

CCM-11580: remove x-eov extension from non sandox spec

7e9b918

simonlabarere approved these changes Sep 10, 2025

View reviewed changes

masl2 approved these changes Sep 10, 2025

View reviewed changes

masl2 requested review from aidenvaines-cgi and sidnhs September 10, 2025 09:06

sidnhs approved these changes Sep 10, 2025

View reviewed changes

simonlabarere merged commit 0c68250 into main Sep 10, 2025
66 of 67 checks passed

simonlabarere deleted the feature/CCM-11580-oas-spec-v1 branch September 10, 2025 09:22

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

CCM-11580: Updates for OAS Spec V1#139

CCM-11580: Updates for OAS Spec V1#139
simonlabarere merged 3 commits into
mainfrom
feature/CCM-11580-oas-spec-v1

m-houston commented Sep 3, 2025 •

edited

Loading

Uh oh!

sonarqubecloud Bot commented Sep 9, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Uh oh!

Conversation

m-houston commented Sep 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Context

Type of changes

Checklist

Sensitive Information Declaration

Uh oh!

sonarqubecloud Bot commented Sep 9, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

m-houston commented Sep 3, 2025 •

edited

Loading