VED-494: OAS

[JamesW1-NHS]

Summary

• Routine Change

  Designate the YAML file as the master OAS Spec.
  Review and merge any differences between the JSON and YAML versions into the master YAML file.
  Remove the redundant JSON file from the repository.
  Ensure the documentation and any dependent services reference the canonical YAML file.

  Notes:

  • The .oas.json file is intended to be the versioned, minified JSON file for sending to APIM, generated from the YAML file. Currently it is required to generate it locally using make oas
  • This ticket does not address the sandbox issues in VED-298. While we were using the JSON as the master OAS spec, the sandbox examples have been modified and have not been linted at all until now. As a temporary measure I have patched the linter with the flag --skip-rule=no-invalid-media-type-examples. See https://nhsd-jira.digital.nhs.uk/browse/VED-298

Reviews Required

• Dev
• Test
• Tech Author
• Product Owner

Review Checklist

ℹ️ This section is to be filled in by the reviewer.

• I have reviewed the changes in this PR and they fill all of the acceptance criteria of the ticket.
• If there were infrastructure, operational, or build changes, I have made sure there is sufficient evidence that the changes will work.
• If there were changes that are outside of the regular release processes e.g. account infrastructure to setup, manual setup for external API integrations, secrets to set, then I have checked that the developer has flagged this to the Tech Lead as release steps.
• I have checked that no Personal Identifiable Data (PID) is logged as part of the changes.

[github-actions]

This branch is working on a ticket in the NHS England VED JIRA Project. Here's a handy link to the ticket:

VED-494

[dlzhry2nhs]

Brilliant work. Looks good to me. One minor suggestion to make the process even simpler, and a couple of general questions about the spec, but I think if they are valid, they would belong in other tickets.

[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

[dlzhry2nhs]

Great work. Looking forward to working with the YAML in future.