diff --git a/specification/api/components/documentation/APIDescription.md b/specification/api/components/documentation/APIDescription.md index 7a6311fe..758489d3 100644 --- a/specification/api/components/documentation/APIDescription.md +++ b/specification/api/components/documentation/APIDescription.md @@ -134,6 +134,13 @@ You need to get your software approved by us before it can go live with this API Before go-live, you must complete a smoke test in the NHS Notify production environment. The smoke test confirms that your live credentials, connectivity, and print workflow operate correctly end-to-end. It will be carried out in coordination with the NHS Notify Supplier API team. +The process is as follows: + +* retrieve and print one or more live test letters through the production API. +* send the printed output to the address provided. +* submit a Management Information (MI) update for verification. + + The process is as follows: * retrieve and print one or more live test letters through the production API. diff --git a/specification/api/components/parameters/correlationId.yml b/specification/api/components/parameters/correlationId.yml index 045130d8..eee033f0 100644 --- a/specification/api/components/parameters/correlationId.yml +++ b/specification/api/components/parameters/correlationId.yml @@ -1,4 +1,4 @@ -name: X-Correlation-ID +name: Correlation-ID in: header description: |- An optional ID which you can use to track transactions across multiple systems. It can take any value, but we recommend avoiding `.` characters. If not provided in the request, NHS Notify will default to a system generated ID in its place.