Skip to content

Commit ca852de

Browse files
alexnuttallalexnuttall
committed
add examples
1 parent 5d1c9c9 commit ca852de

File tree

9 files changed

+131
-16
lines changed

9 files changed

+131
-16
lines changed

‎internal/events/schemas/examples/letter.ACCEPTED.json‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,15 @@
55
"origin": {
66
"domain": "letter-rendering",
77
"event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
8-
"source": "/data-plane/letter-rendering/prod/render-pdf",
8+
"source": "/data-plane/letter-rendering/prod/letter-renderer",
99
"subject": "client/00f3b388-bbe9-41c9-9e76-052d37ee8988/letter-request/0o5Fs0EELR0fUjHjbCnEtdUwQe4_0o5Fs0EELR0fUjHjbCnEtdUwQe5"
1010
},
1111
"specificationId": "1y3q9v1zzzz",
12-
"status": "ACCEPTED"
12+
"status": "ACCEPTED",
13+
"supplierId": "supplier_12345"
1314
},
1415
"datacontenttype": "application/json",
15-
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.ACCEPTED.1.0.0.schema.json",
16+
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.accepted.1.0.0.schema.json",
1617
"id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
1718
"recordedtime": "2025-08-28T08:45:00.000Z",
1819
"severitynumber": 2,
@@ -22,5 +23,5 @@
2223
"subject": "letter-origin/letter-rendering/letter/f47ac10b-58cc-4372-a567-0e02b2c3d479",
2324
"time": "2025-08-28T08:45:00.000Z",
2425
"traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
25-
"type": "uk.nhs.notify.supplier-api.letter.ACCEPTED.v1"
26+
"type": "uk.nhs.notify.supplier-api.letter.accepted.v1"
2627
}

‎internal/events/schemas/examples/letter.FORWARDED.json‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,17 @@
55
"origin": {
66
"domain": "letter-rendering",
77
"event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
8-
"source": "/data-plane/letter-rendering/prod/render-pdf",
8+
"source": "/data-plane/letter-rendering/prod/letter-renderer",
99
"subject": "client/00f3b388-bbe9-41c9-9e76-052d37ee8988/letter-request/0o5Fs0EELR0fUjHjbCnEtdUwQe4_0o5Fs0EELR0fUjHjbCnEtdUwQe5"
1010
},
1111
"reasonCode": "RNIB",
1212
"reasonText": "RNIB",
1313
"specificationId": "1y3q9v1zzzz",
14-
"status": "FORWARDED"
14+
"status": "FORWARDED",
15+
"supplierId": "supplier_12345"
1516
},
1617
"datacontenttype": "application/json",
17-
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.FORWARDED.1.0.0.schema.json",
18+
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.forwarded.1.0.0.schema.json",
1819
"id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
1920
"recordedtime": "2025-08-28T08:45:00.000Z",
2021
"severitynumber": 2,
@@ -24,5 +25,5 @@
2425
"subject": "letter-origin/letter-rendering/letter/f47ac10b-58cc-4372-a567-0e02b2c3d479",
2526
"time": "2025-08-28T08:45:00.000Z",
2627
"traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
27-
"type": "uk.nhs.notify.supplier-api.letter.FORWARDED.v1"
28+
"type": "uk.nhs.notify.supplier-api.letter.forwarded.v1"
2829
}

‎internal/events/schemas/examples/letter.RETURNED.json‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,17 @@
55
"origin": {
66
"domain": "letter-rendering",
77
"event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
8-
"source": "/data-plane/letter-rendering/prod/render-pdf",
8+
"source": "/data-plane/letter-rendering/prod/letter-renderer",
99
"subject": "client/00f3b388-bbe9-41c9-9e76-052d37ee8988/letter-request/0o5Fs0EELR0fUjHjbCnEtdUwQe4_0o5Fs0EELR0fUjHjbCnEtdUwQe5"
1010
},
1111
"reasonCode": "R07",
1212
"reasonText": "No such address",
1313
"specificationId": "1y3q9v1zzzz",
14-
"status": "RETURNED"
14+
"status": "RETURNED",
15+
"supplierId": "supplier_12345"
1516
},
1617
"datacontenttype": "application/json",
17-
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.RETURNED.1.0.0.schema.json",
18+
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.returned.1.0.0.schema.json",
1819
"id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
1920
"recordedtime": "2025-08-28T08:45:00.000Z",
2021
"severitynumber": 2,
@@ -24,5 +25,5 @@
2425
"subject": "letter-origin/letter-rendering/letter/f47ac10b-58cc-4372-a567-0e02b2c3d479",
2526
"time": "2025-08-28T08:45:00.000Z",
2627
"traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
27-
"type": "uk.nhs.notify.supplier-api.letter.RETURNED.v1"
28+
"type": "uk.nhs.notify.supplier-api.letter.returned.v1"
2829
}

‎internal/events/schemas/examples/letter.cancelled.json‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"data": {
3+
"domainId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
4+
"groupId": "client_template",
5+
"origin": {
6+
"domain": "letter-rendering",
7+
"event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
8+
"source": "/data-plane/letter-rendering/prod/letter-renderer",
9+
"subject": "client/00f3b388-bbe9-41c9-9e76-052d37ee8988/letter-request/0o5Fs0EELR0fUjHjbCnEtdUwQe4_0o5Fs0EELR0fUjHjbCnEtdUwQe5"
10+
},
11+
"specificationId": "1y3q9v1zzzz",
12+
"status": "CANCELLED",
13+
"supplierId": "supplier_12345"
14+
},
15+
"datacontenttype": "application/json",
16+
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.cancelled.1.0.0.schema.json",
17+
"id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
18+
"recordedtime": "2025-08-28T08:45:00.000Z",
19+
"severitynumber": 2,
20+
"severitytext": "INFO",
21+
"source": "/data-plane/supplier-api/prod/update-status",
22+
"specversion": "1.0",
23+
"subject": "letter-origin/letter-rendering/letter/f47ac10b-58cc-4372-a567-0e02b2c3d479",
24+
"time": "2025-08-28T08:45:00.000Z",
25+
"traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
26+
"type": "uk.nhs.notify.supplier-api.letter.cancelled.v1"
27+
}

‎internal/events/schemas/examples/letter.dispatched.json‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
{
2+
"data": {
3+
"domainId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
4+
"groupId": "client_template",
5+
"origin": {
6+
"domain": "letter-rendering",
7+
"event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
8+
"source": "/data-plane/letter-rendering/prod/letter-renderer",
9+
"subject": "client/00f3b388-bbe9-41c9-9e76-052d37ee8988/letter-request/0o5Fs0EELR0fUjHjbCnEtdUwQe4_0o5Fs0EELR0fUjHjbCnEtdUwQe5"
10+
},
11+
"specificationId": "1y3q9v1zzzz",
12+
"status": "DISPATCHED",
13+
"supplierId": "supplier_12345"
14+
},
15+
"datacontenttype": "application/json",
16+
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.dispatched.1.0.0.schema.json",
17+
"id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
18+
"recordedtime": "2025-08-28T08:45:00.000Z",
19+
"severitynumber": 2,
20+
"severitytext": "INFO",
21+
"source": "/data-plane/supplier-api/prod/update-status",
22+
"specversion": "1.0",
23+
"subject": "letter-origin/letter-rendering/letter/f47ac10b-58cc-4372-a567-0e02b2c3d479",
24+
"time": "2025-08-28T08:45:00.000Z",
25+
"traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
26+
"type": "uk.nhs.notify.supplier-api.letter.dispatched.v1"
27+
}

‎internal/events/schemas/examples/letter.failed.json‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"data": {
3+
"domainId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
4+
"groupId": "client_template",
5+
"origin": {
6+
"domain": "letter-rendering",
7+
"event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
8+
"source": "/data-plane/letter-rendering/prod/letter-renderer",
9+
"subject": "client/00f3b388-bbe9-41c9-9e76-052d37ee8988/letter-request/0o5Fs0EELR0fUjHjbCnEtdUwQe4_0o5Fs0EELR0fUjHjbCnEtdUwQe5"
10+
},
11+
"reasonCode": "X07",
12+
"reasonText": "Unprintable",
13+
"specificationId": "1y3q9v1zzzz",
14+
"status": "FAILED",
15+
"supplierId": "supplier_12345"
16+
},
17+
"datacontenttype": "application/json",
18+
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.failed.1.0.0.schema.json",
19+
"id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
20+
"recordedtime": "2025-08-28T08:45:00.000Z",
21+
"severitynumber": 2,
22+
"severitytext": "INFO",
23+
"source": "/data-plane/supplier-api/prod/update-status",
24+
"specversion": "1.0",
25+
"subject": "letter-origin/letter-rendering/letter/f47ac10b-58cc-4372-a567-0e02b2c3d479",
26+
"time": "2025-08-28T08:45:00.000Z",
27+
"traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
28+
"type": "uk.nhs.notify.supplier-api.letter.failed.v1"
29+
}

‎internal/events/schemas/examples/letter.rejected.json‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"data": {
3+
"domainId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
4+
"groupId": "client_template",
5+
"origin": {
6+
"domain": "letter-rendering",
7+
"event": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
8+
"source": "/data-plane/letter-rendering/prod/letter-renderer",
9+
"subject": "client/00f3b388-bbe9-41c9-9e76-052d37ee8988/letter-request/0o5Fs0EELR0fUjHjbCnEtdUwQe4_0o5Fs0EELR0fUjHjbCnEtdUwQe5"
10+
},
11+
"reasonCode": "Z07",
12+
"reasonText": "Invalid",
13+
"specificationId": "1y3q9v1zzzz",
14+
"status": "REJECTED",
15+
"supplierId": "supplier_12345"
16+
},
17+
"datacontenttype": "application/json",
18+
"dataschema": "https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.rejected.1.0.0.schema.json",
19+
"id": "23f1f09c-a555-4d9b-8405-0b33490bc920",
20+
"recordedtime": "2025-08-28T08:45:00.000Z",
21+
"severitynumber": 2,
22+
"severitytext": "INFO",
23+
"source": "/data-plane/supplier-api/prod/update-status",
24+
"specversion": "1.0",
25+
"subject": "letter-origin/letter-rendering/letter/f47ac10b-58cc-4372-a567-0e02b2c3d479",
26+
"time": "2025-08-28T08:45:00.000Z",
27+
"traceparent": "00-0af7651916cd43dd8448eb211c80319c-b7ad6b7169203331-01",
28+
"type": "uk.nhs.notify.supplier-api.letter.rejected.v1"
29+
}

‎internal/events/src/cli/generate-json.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,6 @@ const miJson = z.toJSONSchema($MISubmittedEvent, {
5252
target: "openapi-3.0",
5353
reused: "ref",
5454
});
55-
const miFile = `schemas/events/mi.SUBMITTED.schema.json`;
55+
const miFile = `schemas/events/mi.submitted.schema.json`;
5656
fs.writeFileSync(miFile, JSON.stringify(miJson, null, 2));
57-
console.info(`Wrote JSON schema for letter.any to ${miFile}`);
57+
console.info(`Wrote JSON schema for mi.submitted to ${miFile}`);

‎internal/events/src/events/mi-events.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ import { z } from "zod";
22
import { EventEnvelope } from "@nhsdigital/nhs-notify-event-schemas-supplier-api/src/events/event-envelope";
33
import { $MI } from "@nhsdigital/nhs-notify-event-schemas-supplier-api/src/domain/mi";
44

5-
export const $MISubmittedEvent = EventEnvelope("mi.SUBMITTED", "mi", $MI, [
5+
export const $MISubmittedEvent = EventEnvelope("mi.submitted", "mi", $MI, [
66
"SUBMITTED",
77
]).meta({
8-
title: `mi.SUBMITTED Event`,
8+
title: `mi.submitted Event`,
99
description: `Event schema for reporting that MI data has been submitted`,
1010
});
1111
export type MISubmittedEvent = z.infer<typeof $MISubmittedEvent>;

0 commit comments

Comments
 (0)