Update event schema envelope generation

Author: m-houston

internal/events/schemas/events/letter.ACCEPTED.schema.json

@@ -25,23 +25,8 @@
       "format": "uuid",
       "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
     },
-    "source": {
-      "title": "Event Source",
-      "description": "Logical event producer path within the supplier-api domain",
-      "type": "string",
-      "pattern": "^\\/data-plane\\/supplier-api(?:\\/.*)?$"
-    },
-    "subject": {
-      "title": "Event Subject",
-      "description": "Resource path (no leading slash) within the source made of segments separated by '/'.",
-      "examples": [
-        "letter-origin/letter-rendering/letter/f47ac10b-58cc-4372-a567-0e02b2c3d479"
-      ],
-      "type": "string",
-      "pattern": "^letter-origin\\/[a-z0-9-]+\\/letter\\/[^/]+(?:\\/.*)?"
-    },
     "type": {
-      "title": "Letter ACCEPTED event type",
+      "title": "letter.ACCEPTED event type",
       "description": "Event type using reverse-DNS style",
       "examples": [
         "uk.nhs.notify.supplier-api.letter.ACCEPTED.v1"
@@ -51,35 +36,29 @@
         "uk.nhs.notify.supplier-api.letter.ACCEPTED.v1"
       ]
     },
-    "time": {
-      "title": "Event Time",
-      "description": "Timestamp when the event occurred (RFC 3339).",
+    "dataschema": {
+      "title": "Data Schema URI",
+      "description": "URI of a schema that describes the event data\n\nData schema version must match the major version indicated by the type",
       "examples": [
-        "2025-10-01T10:15:30.000Z"
+        "https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.ACCEPTED.1.0.0.schema.json"
       ],
       "type": "string",
-      "format": "date-time",
-      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
+      "pattern": "^https:\\/\\/notify\\.nhs\\.uk\\/cloudevents\\/schemas\\/supplier-api\\/letter\\.(?<status>ACCEPTED)\\.1\\.\\d+\\.\\d+\\.schema.json$"
     },
-    "datacontenttype": {
-      "title": "Data Content Type",
-      "description": "Media type for the data field (fixed to application/json).",
-      "examples": [
-        "application/json"
-      ],
+    "source": {
+      "title": "Event Source",
+      "description": "Logical event producer path within the supplier-api domain",
       "type": "string",
-      "enum": [
-        "application/json"
-      ]
+      "pattern": "^\\/data-plane\\/supplier-api(?:\\/.*)?$"
     },
-    "dataschema": {
-      "title": "Data Schema URI",
-      "description": "URI of a schema that describes the event data\n\nData schema version must match the major version indicated by the type",
+    "subject": {
+      "title": "Event Subject",
+      "description": "Resource path (no leading slash) within the source made of segments separated by '/'.",
       "examples": [
-        "https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.ACCEPTED.1.0.0.schema.json"
+        "letter-origin/letter-rendering/letter/f47ac10b-58cc-4372-a567-0e02b2c3d479"
       ],
       "type": "string",
-      "pattern": "^https:\\/\\/notify\\.nhs\\.uk\\/cloudevents\\/schemas\\/supplier-api\\/letter.ACCEPTED.1\\.\\d+\\.\\d+\\.schema.json$"
+      "pattern": "^letter-origin\\/[a-z0-9-]+\\/letter\\/[a-z0-9-]+$"
     },
     "data": {
       "type": "object",
@@ -145,9 +124,26 @@
           "type": "string"
         },
         "status": {
+          "title": "Letter Status",
+          "description": "The status of a letter in the supplier-api domain.",
+          "examples": [
+            "ACCEPTED",
+            "REJECTED",
+            "PRINTED"
+          ],
           "type": "string",
           "enum": [
-            "ACCEPTED"
+            "PENDING",
+            "ACCEPTED",
+            "REJECTED",
+            "PRINTED",
+            "ENCLOSED",
+            "CANCELLED",
+            "DISPATCHED",
+            "FAILED",
+            "RETURNED",
+            "FORWARDED",
+            "DELIVERED"
           ]
         },
         "reasonCode": {
@@ -177,6 +173,27 @@
         "status"
       ]
     },
+    "time": {
+      "title": "Event Time",
+      "description": "Timestamp when the event occurred (RFC 3339).",
+      "examples": [
+        "2025-10-01T10:15:30.000Z"
+      ],
+      "type": "string",
+      "format": "date-time",
+      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
+    },
+    "datacontenttype": {
+      "title": "Data Content Type",
+      "description": "Media type for the data field (fixed to application/json).",
+      "examples": [
+        "application/json"
+      ],
+      "type": "string",
+      "enum": [
+        "application/json"
+      ]
+    },
     "traceparent": {
       "title": "Traceparent",
       "description": "W3C Trace Context traceparent header value.",
@@ -304,26 +321,19 @@
         "sensitive",
         "special-category"
       ]
-    },
-    "dataschemaversion": {
-      "title": "Data Schema Version",
-      "description": "Matches semantic versioning format with fixed major version (Not part of cloudevents spec?)",
-      "type": "string",
-      "pattern": "^1\\.\\d+\\.\\d+$"
     }
   },
   "required": [
     "specversion",
     "id",
-    "source",
-    "subject",
     "type",
-    "time",
     "dataschema",
+    "source",
+    "subject",
     "data",
+    "time",
     "traceparent",
     "recordedtime",
-    "severitynumber",
-    "dataschemaversion"
+    "severitynumber"
   ]
 }

internal/events/schemas/events/letter.CANCELLED.schema.json

@@ -25,23 +25,8 @@
       "format": "uuid",
       "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
     },
-    "source": {
-      "title": "Event Source",
-      "description": "Logical event producer path within the supplier-api domain",
-      "type": "string",
-      "pattern": "^\\/data-plane\\/supplier-api(?:\\/.*)?$"
-    },
-    "subject": {
-      "title": "Event Subject",
-      "description": "Resource path (no leading slash) within the source made of segments separated by '/'.",
-      "examples": [
-        "letter-origin/letter-rendering/letter/f47ac10b-58cc-4372-a567-0e02b2c3d479"
-      ],
-      "type": "string",
-      "pattern": "^letter-origin\\/[a-z0-9-]+\\/letter\\/[^/]+(?:\\/.*)?"
-    },
     "type": {
-      "title": "Letter CANCELLED event type",
+      "title": "letter.CANCELLED event type",
       "description": "Event type using reverse-DNS style",
       "examples": [
         "uk.nhs.notify.supplier-api.letter.CANCELLED.v1"
@@ -51,35 +36,29 @@
         "uk.nhs.notify.supplier-api.letter.CANCELLED.v1"
       ]
     },
-    "time": {
-      "title": "Event Time",
-      "description": "Timestamp when the event occurred (RFC 3339).",
+    "dataschema": {
+      "title": "Data Schema URI",
+      "description": "URI of a schema that describes the event data\n\nData schema version must match the major version indicated by the type",
       "examples": [
-        "2025-10-01T10:15:30.000Z"
+        "https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.CANCELLED.1.0.0.schema.json"
       ],
       "type": "string",
-      "format": "date-time",
-      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
+      "pattern": "^https:\\/\\/notify\\.nhs\\.uk\\/cloudevents\\/schemas\\/supplier-api\\/letter\\.(?<status>CANCELLED)\\.1\\.\\d+\\.\\d+\\.schema.json$"
     },
-    "datacontenttype": {
-      "title": "Data Content Type",
-      "description": "Media type for the data field (fixed to application/json).",
-      "examples": [
-        "application/json"
-      ],
+    "source": {
+      "title": "Event Source",
+      "description": "Logical event producer path within the supplier-api domain",
       "type": "string",
-      "enum": [
-        "application/json"
-      ]
+      "pattern": "^\\/data-plane\\/supplier-api(?:\\/.*)?$"
     },
-    "dataschema": {
-      "title": "Data Schema URI",
-      "description": "URI of a schema that describes the event data\n\nData schema version must match the major version indicated by the type",
+    "subject": {
+      "title": "Event Subject",
+      "description": "Resource path (no leading slash) within the source made of segments separated by '/'.",
       "examples": [
-        "https://notify.nhs.uk/cloudevents/schemas/supplier-api/letter.ACCEPTED.1.0.0.schema.json"
+        "letter-origin/letter-rendering/letter/f47ac10b-58cc-4372-a567-0e02b2c3d479"
       ],
       "type": "string",
-      "pattern": "^https:\\/\\/notify\\.nhs\\.uk\\/cloudevents\\/schemas\\/supplier-api\\/letter.CANCELLED.1\\.\\d+\\.\\d+\\.schema.json$"
+      "pattern": "^letter-origin\\/[a-z0-9-]+\\/letter\\/[a-z0-9-]+$"
     },
     "data": {
       "type": "object",
@@ -145,9 +124,26 @@
           "type": "string"
         },
         "status": {
+          "title": "Letter Status",
+          "description": "The status of a letter in the supplier-api domain.",
+          "examples": [
+            "ACCEPTED",
+            "REJECTED",
+            "PRINTED"
+          ],
           "type": "string",
           "enum": [
-            "CANCELLED"
+            "PENDING",
+            "ACCEPTED",
+            "REJECTED",
+            "PRINTED",
+            "ENCLOSED",
+            "CANCELLED",
+            "DISPATCHED",
+            "FAILED",
+            "RETURNED",
+            "FORWARDED",
+            "DELIVERED"
           ]
         },
         "reasonCode": {
@@ -177,6 +173,27 @@
         "status"
       ]
     },
+    "time": {
+      "title": "Event Time",
+      "description": "Timestamp when the event occurred (RFC 3339).",
+      "examples": [
+        "2025-10-01T10:15:30.000Z"
+      ],
+      "type": "string",
+      "format": "date-time",
+      "pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d(?::[0-5]\\d(?:\\.\\d+)?)?(?:Z))$"
+    },
+    "datacontenttype": {
+      "title": "Data Content Type",
+      "description": "Media type for the data field (fixed to application/json).",
+      "examples": [
+        "application/json"
+      ],
+      "type": "string",
+      "enum": [
+        "application/json"
+      ]
+    },
     "traceparent": {
       "title": "Traceparent",
       "description": "W3C Trace Context traceparent header value.",
@@ -304,26 +321,19 @@
         "sensitive",
         "special-category"
       ]
-    },
-    "dataschemaversion": {
-      "title": "Data Schema Version",
-      "description": "Matches semantic versioning format with fixed major version (Not part of cloudevents spec?)",
-      "type": "string",
-      "pattern": "^1\\.\\d+\\.\\d+$"
     }
   },
   "required": [
     "specversion",
     "id",
-    "source",
-    "subject",
     "type",
-    "time",
     "dataschema",
+    "source",
+    "subject",
     "data",
+    "time",
     "traceparent",
     "recordedtime",
-    "severitynumber",
-    "dataschemaversion"
+    "severitynumber"
   ]
 }