Feature/cdapi 141

[nhsd-jack-wainwright]

Description

Minor alterations to the overview text included within the Open API Specification as well as the inclusion of a new high level architecture diagram.

Context

This change adds some additional context around the product, as well as incorporating some feedback on the overview wording.

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 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
• Exceptions/Exclusions to coding standards (e.g. #noqa or #NOSONAR) are included within this Pull Request.

---

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.

[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

[github-actions]

Deployment Complete

• Preview with mock:
  • URL: https://feature-cdapi-141.dev.endpoints.pathology-laboratory-reporting.national.nhs.uk — Status
    • Smoke test result: ✅ Passed (HTTP 200)
  • Proxy URL: https://internal-dev.api.service.nhs.uk/pathology-laboratory-reporting-pr-100
  • Lambda function: pr-feature-cdapi-141
• Mock endpoints:
  • URL: https://feature-cdapi-141.m.dev.endpoints.pathology-laboratory-reporting.national.nhs.uk
    • Smoke test result: ✅ Passed (HTTP 200)
  • Lambda function: mock-feature-cdapi-141
• Preview with integration:
  • URL: https://feature-cdapi-141.i.dev.endpoints.pathology-laboratory-reporting.national.nhs.uk — Status
    • Smoke test result: ✅ Passed (HTTP 200)
  • Proxy URL: https://internal-dev.api.service.nhs.uk/pathology-laboratory-reporting-pri-100
  • Lambda function: int-feature-cdapi-141