Feature/cdapi 83

[nhsd-jack-wainwright]

Description

Addition of an initial Open API specification detailing the Pathology API.

Context

This change includes an initial draft OAS file that describes the Pathology API. This includes detailing both the expected request and response, as well as any error scenarios clients might incur whilst utilising the API. The included OAS file also includes some details on how the API is expected to be used, and initial content on how clients can onboard to the APIs.

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.

[github-actions]

✅ Trivy gate: no Critical/High vulnerabilities.

Trivy Filesystem Scan Summary

Filesystem: /tmp/artifact

Severity	Count
CRITICAL	0
HIGH	0
MEDIUM	0
LOW	0
UNKNOWN	0

✅ No vulnerabilities found.

[github-actions]

Deployment Complete

• Preview URL: https://feature-cdapi-83.dev.endpoints.pathology-laboratory-reporting.national.nhs.uk — Status
  • Smoke Test: ✅ Passed (HTTP 200)
• Mock URL: https://feature-cdapi-83.m.dev.endpoints.pathology-laboratory-reporting.national.nhs.uk
  • Smoke Mock Test: ✅ Passed (HTTP 200)
• Proxy URL: https://internal-dev.api.service.nhs.uk/pathology-laboratory-reporting-pr-37
• Lambda Function: pr-feature-cdapi-83
• Mock Lambda Function: mock-feature-cdapi-83

[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