diff --git a/.gitleaksignore b/.gitleaksignore index c2a21bcf0..3a1e68feb 100644 --- a/.gitleaksignore +++ b/.gitleaksignore @@ -12,3 +12,7 @@ cd9c0efec38c5d63053dd865e5d4e207c0760d91:docs/guides/Perform_static_analysis.md: 973c8a1feb76f3cd8743ce27b14e4acc4252240c:src/TESTING_PLAN.md:ipv4:2507 cc74128e4207833109339e96f3aaebf3cd40dd65:src/TESTING_PLAN.md:ipv4:2507 791619daf5af4806da7266fa301c0e82145b6de8:src/TESTING_PLAN.md:ipv4:2507 +f8546e35b77b69ba7b15dbe3174d2d7e375200ef:utils/utils/src/__tests__/key-generation/validate-private-key.test.ts:private-key:7 +f8546e35b77b69ba7b15dbe3174d2d7e375200ef:utils/utils/src/__tests__/key-generation/get-private-key.test.ts:private-key:23 +f8546e35b77b69ba7b15dbe3174d2d7e375200ef:utils/utils/src/__tests__/key-generation/get-private-key.test.ts:private-key:30 +f8546e35b77b69ba7b15dbe3174d2d7e375200ef:utils/utils/src/__tests__/key-generation/get-private-key.test.ts:private-key:46 diff --git a/README.md b/README.md index fb489f8c2..b771f4d75 100644 --- a/README.md +++ b/README.md @@ -101,17 +101,28 @@ _No common schemas defined yet._ | ----------- | ------------- | ---------------- | ------------- | | **Core.request.submitted Data.v1** | [`src/digital-letters/2025-10-draft/data/core.request.submitted-data.v1.schema.yaml`](src/digital-letters/2025-10-draft/data/core.request.submitted-data.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/core.request.submitted-data.v1.schema.json`](schemas/digital-letters/2025-10-draft/data/core.request.submitted-data.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/core.request.submitted-data.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/core.request.submitted-data.v1.schema.md) | | **Digital Letter Base Data** | [`src/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.md) | +| **Digital Letters Digital Letter Read Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.md) | | **Digital Letters Mesh Inbox Message Downloaded Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-downloaded-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-downloaded-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-downloaded-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-downloaded-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-downloaded-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-downloaded-data.schema.md) | | **Digital Letters Mesh Inbox Message Received Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.md) | +| **Digital Letters Message Request Failed Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-message-request-failed-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-message-request-failed-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-message-request-failed-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-message-request-failed-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-message-request-failed-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-message-request-failed-data.schema.md) | +| **Digital Letters Message Request Submitted Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-message-request-submitted-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-message-request-submitted-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-message-request-submitted-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-message-request-submitted-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-message-request-submitted-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-message-request-submitted-data.schema.md) | | **Digital Letters Pdm Resource Available Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.md) | | **Digital Letters Pdm Resource Retries Exceeded Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-retries-exceeded-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-retries-exceeded-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-retries-exceeded-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-retries-exceeded-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-retries-exceeded-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-retries-exceeded-data.schema.md) | | **Digital Letters Pdm Resource Submission Rejected Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submission-rejected-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submission-rejected-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submission-rejected-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submission-rejected-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submission-rejected-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submission-rejected-data.schema.md) | | **Digital Letters Pdm Resource Submitted Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submitted-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submitted-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submitted-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submitted-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submitted-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-submitted-data.schema.md) | | **Digital Letters Pdm Resource Unavailable Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.md) | -| **Messages.status.updated Data.v1** | [`src/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.yaml`](src/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.json`](schemas/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.md) | +| **Digital Letters Queue Item Dequeued Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.md) | +| **Digital Letters Queue Item Enqueued Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.md) | +| **Digital Letters Queue Item Removed Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.md) | +| **Digital Letters Reporting Generate Report Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.md) | +| **Digital Letters Reporting Report Generated Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.md) | +| **Digital Letters Reporting Report Sent Data** | [`src/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.yaml`](src/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.yaml) | [`schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.json`](schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.md) | +| **Core** | [`src/digital-letters/2025-10-draft/defs/core.schema.yaml`](src/digital-letters/2025-10-draft/defs/core.schema.yaml) | [`schemas/digital-letters/2025-10-draft/defs/core.schema.json`](schemas/digital-letters/2025-10-draft/defs/core.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/defs/core.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/defs/core.schema.md) | +| **Mesh** | [`src/digital-letters/2025-10-draft/defs/mesh.schema.yaml`](src/digital-letters/2025-10-draft/defs/mesh.schema.yaml) | [`schemas/digital-letters/2025-10-draft/defs/mesh.schema.json`](schemas/digital-letters/2025-10-draft/defs/mesh.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/defs/mesh.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/defs/mesh.schema.md) | | **Message Id** | [`src/digital-letters/2025-10-draft/defs/message-id.schema.yaml`](src/digital-letters/2025-10-draft/defs/message-id.schema.yaml) | [`schemas/digital-letters/2025-10-draft/defs/message-id.schema.json`](schemas/digital-letters/2025-10-draft/defs/message-id.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/defs/message-id.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/defs/message-id.schema.md) | | **Message Status** | [`src/digital-letters/2025-10-draft/defs/message-status.schema.yaml`](src/digital-letters/2025-10-draft/defs/message-status.schema.yaml) | [`schemas/digital-letters/2025-10-draft/defs/message-status.schema.json`](schemas/digital-letters/2025-10-draft/defs/message-status.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/defs/message-status.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/defs/message-status.schema.md) | | **Pdm** | [`src/digital-letters/2025-10-draft/defs/pdm.schema.yaml`](src/digital-letters/2025-10-draft/defs/pdm.schema.yaml) | [`schemas/digital-letters/2025-10-draft/defs/pdm.schema.json`](schemas/digital-letters/2025-10-draft/defs/pdm.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/defs/pdm.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/defs/pdm.schema.md) | +| **Reporting** | [`src/digital-letters/2025-10-draft/defs/reporting.schema.yaml`](src/digital-letters/2025-10-draft/defs/reporting.schema.yaml) | [`schemas/digital-letters/2025-10-draft/defs/reporting.schema.json`](schemas/digital-letters/2025-10-draft/defs/reporting.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/defs/reporting.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/defs/reporting.schema.md) | | **Requests** | [`src/digital-letters/2025-10-draft/defs/requests.schema.yaml`](src/digital-letters/2025-10-draft/defs/requests.schema.yaml) | [`schemas/digital-letters/2025-10-draft/defs/requests.schema.json`](schemas/digital-letters/2025-10-draft/defs/requests.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/defs/requests.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/defs/requests.schema.md) | | **Someobject** | [`src/digital-letters/2025-10-draft/defs/someobject.schema.yaml`](src/digital-letters/2025-10-draft/defs/someobject.schema.yaml) | [`schemas/digital-letters/2025-10-draft/defs/someobject.schema.json`](schemas/digital-letters/2025-10-draft/defs/someobject.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/defs/someobject.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/defs/someobject.schema.md) | | **Profile** | [`src/digital-letters/2025-10-draft/digital-letters-event-bus-profile.schema.yaml`](src/digital-letters/2025-10-draft/digital-letters-event-bus-profile.schema.yaml) | [`schemas/digital-letters/2025-10-draft/digital-letters-event-bus-profile.schema.json`](schemas/digital-letters/2025-10-draft/digital-letters-event-bus-profile.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/digital-letters-event-bus-profile.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/digital-letters-event-bus-profile.schema.md) | @@ -144,8 +155,10 @@ _No common schemas defined yet._ | **Uk.nhs.notify.digital.letters.queue.item.enqueued.v1** | [`src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1.schema.yaml`](src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1.schema.json`](schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1.schema.md) | | **Uk.nhs.notify.digital.letters.queue.item.removed.v1** | [`src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.removed.v1.schema.yaml`](src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.removed.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.removed.v1.schema.json`](schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.removed.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.removed.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.removed.v1.schema.md) | | **Uk.nhs.notify.digital.letters.queue.timer.expired.v1** | [`src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.timer.expired.v1.schema.yaml`](src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.timer.expired.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.timer.expired.v1.schema.json`](schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.timer.expired.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.timer.expired.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.timer.expired.v1.schema.md) | -| **Uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1** | [`src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1.schema.yaml`](src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1.schema.json`](schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1.schema.md) | -| **Uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1** | [`src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1.schema.yaml`](src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1.schema.json`](schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1.schema.md) | +| **Uk.nhs.notify.digital.letters.reporting.generate.report.v1** | [`src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.generate.report.v1.schema.yaml`](src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.generate.report.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.generate.report.v1.schema.json`](schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.generate.report.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.generate.report.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.generate.report.v1.schema.md) | +| **Uk.nhs.notify.digital.letters.reporting.report.generated.v1** | [`src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.generated.v1.schema.yaml`](src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.generated.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.generated.v1.schema.json`](schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.generated.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.generated.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.generated.v1.schema.md) | +| **Uk.nhs.notify.digital.letters.reporting.report.sent.v1** | [`src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.sent.v1.schema.yaml`](src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.sent.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.sent.v1.schema.json`](schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.sent.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.sent.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.sent.v1.schema.md) | +| **Uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1** | [`src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1.schema.yaml`](src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1.schema.json`](schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1.schema.md) | | **Uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1** | [`src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1.schema.yaml`](src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1.schema.json`](schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1.schema.md) | | **Uk.nhs.notify.supplierapi.letter.printed.v1** | [`src/digital-letters/2025-10-draft/events/uk.nhs.notify.supplierapi.letter.printed.v1.schema.yaml`](src/digital-letters/2025-10-draft/events/uk.nhs.notify.supplierapi.letter.printed.v1.schema.yaml) | [`schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.supplierapi.letter.printed.v1.schema.json`](schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.supplierapi.letter.printed.v1.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.supplierapi.letter.printed.v1.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.supplierapi.letter.printed.v1.schema.md) | | **Nhs Notify Document Reference** | [`src/digital-letters/2025-10-draft/nhs-notify-document-reference.schema.yaml`](src/digital-letters/2025-10-draft/nhs-notify-document-reference.schema.yaml) | [`schemas/digital-letters/2025-10-draft/nhs-notify-document-reference.schema.json`](schemas/digital-letters/2025-10-draft/nhs-notify-document-reference.schema.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/nhs-notify-document-reference.schema.md`](../../docs/cloudevents/digital-letters/2025-10-draft/nhs-notify-document-reference.schema.md) | @@ -174,8 +187,10 @@ _No common schemas defined yet._ | **Uk.nhs.notify.digital.letters.queue.item.enqueued.v1** | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1-event.json`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1-event.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1-event.md`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1-event.md) | | **Uk.nhs.notify.digital.letters.queue.item.removed.v1** | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.removed.v1-event.json`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.removed.v1-event.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.removed.v1-event.md`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.item.removed.v1-event.md) | | **Uk.nhs.notify.digital.letters.queue.timer.expired.v1** | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.timer.expired.v1-event.json`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.timer.expired.v1-event.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.timer.expired.v1-event.md`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.timer.expired.v1-event.md) | -| **Uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1** | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1-event.json`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1-event.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1-event.md`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1-event.md) | -| **Uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1** | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1-event.json`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1-event.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1-event.md`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1-event.md) | +| **Uk.nhs.notify.digital.letters.reporting.generate.report.v1** | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.generate.report.v1-event.json`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.generate.report.v1-event.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.generate.report.v1-event.md`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.generate.report.v1-event.md) | +| **Uk.nhs.notify.digital.letters.reporting.report.generated.v1** | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.generated.v1-event.json`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.generated.v1-event.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.generated.v1-event.md`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.generated.v1-event.md) | +| **Uk.nhs.notify.digital.letters.reporting.report.sent.v1** | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.sent.v1-event.json`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.sent.v1-event.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.sent.v1-event.md`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.sent.v1-event.md) | +| **Uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1** | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1-event.json`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1-event.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1-event.md`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1-event.md) | | **Uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1** | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1-event.json`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1-event.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1-event.md`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1-event.md) | | **Uk.nhs.notify.supplierapi.letter.printed.v1** | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.supplierapi.letter.printed.v1-event.json`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.supplierapi.letter.printed.v1-event.json) | [`../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.supplierapi.letter.printed.v1-event.md`](../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.supplierapi.letter.printed.v1-event.md) | diff --git a/scripts/config/vale/styles/config/vocabularies/words/accept.txt b/scripts/config/vale/styles/config/vocabularies/words/accept.txt index f9f75ec86..0ad530c94 100644 --- a/scripts/config/vale/styles/config/vocabularies/words/accept.txt +++ b/scripts/config/vale/styles/config/vocabularies/words/accept.txt @@ -16,6 +16,7 @@ Cognito config Cyber datetime +[Dd]equeued deduplication Dependabot dereference @@ -24,6 +25,7 @@ dev draw.io drawio D'Roza +[Ee]nqueued [Ee]num endcapture endfor diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.yaml new file mode 100644 index 000000000..dc7823190 --- /dev/null +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.yaml @@ -0,0 +1,13 @@ +$schema: https://json-schema.org/draft/2020-12/schema +title: DigitalLetterRead Data +description: Data payload of the DigitalLetterRead event +type: object +additionalProperties: false +properties: + messageReference: + $ref: ../defs/requests.schema.yaml#/properties/messageReference + senderId: + $ref: ../defs/requests.schema.yaml#/properties/senderId +required: + - messageReference + - senderId diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.yaml index b6c41248e..6a01f4cff 100644 --- a/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.yaml +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.yaml @@ -1,14 +1,10 @@ $schema: https://json-schema.org/draft/2020-12/schema -title: Placeholder Data -description: Base data for digital letters - a placeholder until all data schemas are defined +title: MESHInboxMessageReceived Data +description: Data payload of the MESHInboxMessageReceived event type: object additionalProperties: false properties: meshMessageId: - type: string - minLength: 1 - description: Id of the message in the MESH inbox - examples: - - "20200601122152994285_D59900" + $ref: ../defs/mesh.schema.yaml#/properties/meshMessageId required: - meshMessageId diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-message-request-failed-data.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-message-request-failed-data.schema.yaml new file mode 100644 index 000000000..77d581f4d --- /dev/null +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-message-request-failed-data.schema.yaml @@ -0,0 +1,19 @@ +$schema: https://json-schema.org/draft/2020-12/schema +title: MessageRequestSendingFailed Data +description: Data payload of the MessageRequestSendingFailed event +type: object +additionalProperties: false +properties: + messageReference: + $ref: ../defs/requests.schema.yaml#/properties/messageReference + senderId: + $ref: ../defs/requests.schema.yaml#/properties/senderId + messageUri: + $ref: ../defs/requests.schema.yaml#/properties/messageUri + failureCode: + $ref: ../defs/core.schema.yaml#/properties/failureCode +required: + - messageReference + - senderId + - messageUri + - failureCode diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-message-request-submitted-data.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-message-request-submitted-data.schema.yaml new file mode 100644 index 000000000..efa3f02c4 --- /dev/null +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-message-request-submitted-data.schema.yaml @@ -0,0 +1,19 @@ +$schema: https://json-schema.org/draft/2020-12/schema +title: NotifyMessageRequestSubmitted Data +description: Data payload of the NotifyMessageRequestSubmitted event +type: object +additionalProperties: false +properties: + messageReference: + $ref: ../defs/requests.schema.yaml#/properties/messageReference + senderId: + $ref: ../defs/requests.schema.yaml#/properties/senderId + messageUri: + $ref: ../defs/requests.schema.yaml#/properties/messageUri + notifyId: + $ref: ../defs/core.schema.yaml#/properties/notifyId +required: + - messageReference + - senderId + - messageUri + - notifyId diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.yaml new file mode 100644 index 000000000..25a814d1a --- /dev/null +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.yaml @@ -0,0 +1,16 @@ +$schema: https://json-schema.org/draft/2020-12/schema +title: ItemDequeued Data +description: Data payload of the ItemDequeued event +type: object +additionalProperties: false +properties: + messageReference: + $ref: ../defs/requests.schema.yaml#/properties/messageReference + senderId: + $ref: ../defs/requests.schema.yaml#/properties/senderId + messageUri: + $ref: ../defs/requests.schema.yaml#/properties/messageUri +required: + - messageReference + - senderId + - messageUri diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.yaml new file mode 100644 index 000000000..f55a07eff --- /dev/null +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.yaml @@ -0,0 +1,16 @@ +$schema: https://json-schema.org/draft/2020-12/schema +title: ItemEnqueued Data +description: Data payload of the ItemEnqueued event +type: object +additionalProperties: false +properties: + messageReference: + $ref: ../defs/requests.schema.yaml#/properties/messageReference + senderId: + $ref: ../defs/requests.schema.yaml#/properties/senderId + messageUri: + $ref: ../defs/requests.schema.yaml#/properties/messageUri +required: + - messageReference + - senderId + - messageUri diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.yaml new file mode 100644 index 000000000..2a5257033 --- /dev/null +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.yaml @@ -0,0 +1,16 @@ +$schema: https://json-schema.org/draft/2020-12/schema +title: ItemRemoved Data +description: Data payload of the ItemRemoved event +type: object +additionalProperties: false +properties: + messageReference: + $ref: ../defs/requests.schema.yaml#/properties/messageReference + senderId: + $ref: ../defs/requests.schema.yaml#/properties/senderId + messageUri: + $ref: ../defs/requests.schema.yaml#/properties/messageUri +required: + - messageReference + - senderId + - messageUri diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.yaml new file mode 100644 index 000000000..45b12834c --- /dev/null +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.yaml @@ -0,0 +1,10 @@ +$schema: https://json-schema.org/draft/2020-12/schema +title: GenerateReport Data +description: Data payload of the GenerateReport event +type: object +additionalProperties: false +properties: + senderId: + $ref: ../defs/requests.schema.yaml#/properties/senderId +required: + - senderId diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.yaml new file mode 100644 index 000000000..6bfaefa9f --- /dev/null +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.yaml @@ -0,0 +1,13 @@ +$schema: https://json-schema.org/draft/2020-12/schema +title: ReportGenerated Data +description: Data payload of the ReportGenerated event +type: object +additionalProperties: false +properties: + senderId: + $ref: ../defs/requests.schema.yaml#/properties/senderId + reportUri: + $ref: ../defs/reporting.schema.yaml#/properties/reportUri +required: + - senderId + - reportUri diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.yaml new file mode 100644 index 000000000..da748046e --- /dev/null +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.yaml @@ -0,0 +1,13 @@ +$schema: https://json-schema.org/draft/2020-12/schema +title: ReportSent Data +description: Data payload of the ReportSent event +type: object +additionalProperties: false +properties: + senderId: + $ref: ../defs/requests.schema.yaml#/properties/senderId + meshMailboxId: + $ref: ../defs/mesh.schema.yaml#/properties/meshMailboxId +required: + - senderId + - meshMailboxId diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.yaml deleted file mode 100644 index 10a1f51f8..000000000 --- a/src/cloudevents/domains/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.yaml +++ /dev/null @@ -1,13 +0,0 @@ -$schema: https://json-schema.org/draft/2020-12/schema -title: messages.status.updated-data.v1 -description: do this later -type: object -additionalProperties: false -properties: - messageId: - $ref: ../defs/message-id.schema.yaml#/$defs/messageId - messageStatus: - $ref: ../defs/message-status.schema.yaml#/$defs/messageStatus -required: - - messageId - - messageStatus diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/defs/core.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/defs/core.schema.yaml new file mode 100644 index 000000000..1298e796c --- /dev/null +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/defs/core.schema.yaml @@ -0,0 +1,20 @@ +$schema: https://json-schema.org/draft/2020-12/schema +title: Request data +description: Reusable types for NHS Notify payload schemas. +type: object +properties: + notifyId: + type: string + description: "KSUID assigned by Notify to uniquely identify the message request" + minLength: 27 + maxLength: 27 + pattern: "^[0-9a-zA-Z]{27}$" + examples: + - "35bVTLgU9sVCukH6Cgri39g5xPF" + failureCode: + type: string + description: "A code representing the reason for failure" + examples: + - "CM_NOT_ALLOWED" + - "CM_NO_SUCH_ROUTING_PLAN" + - "CM_DUPLICATE_REQUEST" diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/defs/mesh.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/defs/mesh.schema.yaml new file mode 100644 index 000000000..247829144 --- /dev/null +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/defs/mesh.schema.yaml @@ -0,0 +1,17 @@ +$schema: https://json-schema.org/draft/2020-12/schema +title: Request data +description: Reusable types for NHS Notify payload schemas. +type: object +properties: + meshMessageId: + type: string + minLength: 1 + description: Id of the message in the MESH inbox + examples: + - "20200601122152994285_D59900" + meshMailboxId: + type: string + minLength: 1 + description: Id of the mailbox + examples: + - "MAILBOX01" diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/defs/reporting.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/defs/reporting.schema.yaml new file mode 100644 index 000000000..39a1ee7dc --- /dev/null +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/defs/reporting.schema.yaml @@ -0,0 +1,11 @@ +$schema: https://json-schema.org/draft/2020-12/schema +title: Request data +description: Reusable types for NHS Notify payload schemas. +type: object +properties: + reportUri: + type: string + format: uri + description: Uri to the storage location of the generated status report + examples: + - "s3://my-bucket/path/to/my-report" diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.messages.request.sent.v1.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.messages.request.sent.v1.schema.yaml index e7439f5f4..1d9e724bb 100644 --- a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.messages.request.sent.v1.schema.yaml +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.messages.request.sent.v1.schema.yaml @@ -1,5 +1,5 @@ $schema: https://json-schema.org/draft/2020-12/schema -title: NotifyMessageRequestSentToCitizen +title: MessageRequestFailed type: object allOf: - $ref: ../digital-letters-messages-profile.schema.yaml @@ -7,18 +7,17 @@ properties: type: type: string const: uk.nhs.notify.digital.letters.messages.request.sent.v1 - description: Concrete versioned event type string for this example event (.vN suffix). + description: Concrete versioned event type string for this event (.vN suffix). source: type: string pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/messages - description: Event source for digital letters examples. + description: Event source for digital letters. dataschema: type: string - const: ../data/messages.status.updated-data.v1.schema.yaml - description: Canonical URI of the example event's data schema. + const: ../data/digital-letters-message-request-failed-data.schema.yaml + description: Canonical URI of the event's data schema. examples: - - messages.status.updated-data.v1.schema.yaml + - digital-letters-message-request-failed-data.schema.yaml data: - $ref: ../data/messages.status.updated-data.v1.schema.yaml - description: Example payload wrapper containing notify-payload. + $ref: ../data/digital-letters-message-request-failed-data.schema.yaml diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.messages.request.submitted.v1.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.messages.request.submitted.v1.schema.yaml index 846bc41d0..8b2167105 100644 --- a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.messages.request.submitted.v1.schema.yaml +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.messages.request.submitted.v1.schema.yaml @@ -1,5 +1,5 @@ $schema: https://json-schema.org/draft/2020-12/schema -title: NotifyMessageRequestSubmitted +title: MessageRequestSubmitted type: object allOf: - $ref: ../digital-letters-messages-profile.schema.yaml @@ -7,18 +7,17 @@ properties: type: type: string const: uk.nhs.notify.digital.letters.messages.request.submitted.v1 - description: Concrete versioned event type string for this example event (.vN suffix). + description: Concrete versioned event type string for this event (.vN suffix). source: type: string pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/messages - description: Event source for digital letters examples. + description: Event source for digital letters. dataschema: type: string - const: ../data/messages.status.updated-data.v1.schema.yaml - description: Canonical URI of the example event's data schema. + const: ../data/digital-letters-message-request-submitted-data.schema.yaml + description: Canonical URI of the event's data schema. examples: - - messages.status.updated-data.v1.schema.yaml + - digital-letters-message-request-submitted-data.schema.yaml data: - $ref: ../data/messages.status.updated-data.v1.schema.yaml - description: Example payload wrapper containing notify-payload. + $ref: ../data/digital-letters-message-request-submitted-data.schema.yaml diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.dequeued.v1.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.dequeued.v1.schema.yaml index 78288b897..fcf71cff8 100644 --- a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.dequeued.v1.schema.yaml +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.dequeued.v1.schema.yaml @@ -7,18 +7,17 @@ properties: type: type: string const: uk.nhs.notify.digital.letters.queue.item.dequeued.v1 - description: Concrete versioned event type string for this example event (.vN suffix). + description: Concrete versioned event type string for this event (.vN suffix). source: type: string pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/queue - description: Event source for digital letters examples. + description: Event source for digital letters. dataschema: type: string - const: ../data/digital-letter-base-data.schema.yaml - description: Canonical URI of the example event's data schema. + const: ../data/digital-letters-queue-item-dequeued-data.schema.yaml + description: Canonical URI of the event's data schema. examples: - - digital-letter-base-data.schema.yaml + - digital-letters-queue-item-dequeued-data.schema.yaml data: - $ref: ../data/digital-letter-base-data.schema.yaml - description: Example payload wrapper containing notify-payload. + $ref: ../data/digital-letters-queue-item-dequeued-data.schema.yaml diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1.schema.yaml index e39cf60b4..9ced7d09a 100644 --- a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1.schema.yaml +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.enqueued.v1.schema.yaml @@ -7,18 +7,17 @@ properties: type: type: string const: uk.nhs.notify.digital.letters.queue.item.enqueued.v1 - description: Concrete versioned event type string for this example event (.vN suffix). + description: Concrete versioned event type string for this event (.vN suffix). source: type: string pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/queue - description: Event source for digital letters examples. + description: Event source for digital letters. dataschema: type: string - const: ../data/digital-letter-base-data.schema.yaml - description: Canonical URI of the example event's data schema. + const: ../data/digital-letters-queue-item-enqueued-data.schema.yaml + description: Canonical URI of the event's data schema. examples: - - digital-letter-base-data.schema.yaml + - digital-letters-queue-item-enqueued-data.schema.yaml data: - $ref: ../data/digital-letter-base-data.schema.yaml - description: Example payload wrapper containing notify-payload. + $ref: ../data/digital-letters-queue-item-enqueued-data.schema.yaml diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.removed.v1.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.removed.v1.schema.yaml index c5f9b11b7..08bf41576 100644 --- a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.removed.v1.schema.yaml +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.item.removed.v1.schema.yaml @@ -7,18 +7,17 @@ properties: type: type: string const: uk.nhs.notify.digital.letters.queue.item.removed.v1 - description: Concrete versioned event type string for this example event (.vN suffix). + description: Concrete versioned event type string for this event (.vN suffix). source: type: string pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/queue - description: Event source for digital letters examples. + description: Event source for digital letters. dataschema: type: string - const: ../data/digital-letter-base-data.schema.yaml - description: Canonical URI of the example event's data schema. + const: ../data/digital-letters-queue-item-removed-data.schema.yaml + description: Canonical URI of the event's data schema. examples: - - digital-letter-base-data.schema.yaml + - digital-letters-queue-item-removed-data.schema.yaml data: - $ref: ../data/digital-letter-base-data.schema.yaml - description: Example payload wrapper containing notify-payload. + $ref: ../data/digital-letters-queue-item-removed-data.schema.yaml diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.generate.report.v1.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.generate.report.v1.schema.yaml new file mode 100644 index 000000000..60781d491 --- /dev/null +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.generate.report.v1.schema.yaml @@ -0,0 +1,24 @@ +$schema: https://json-schema.org/draft/2020-12/schema +title: GenerateReport +type: object +allOf: + - $ref: ../digital-letters-reporting-profile.schema.yaml +properties: + type: + type: string + const: uk.nhs.notify.digital.letters.reporting.generate.report.v1 + description: Concrete versioned event type string for this event (.vN suffix). + source: + type: string + pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/reporting + description: Event source for digital letters. + + dataschema: + type: string + const: ../data/digital-letters-reporting-generate-report-data.schema.yaml + description: Canonical URI of the event's data schema. + examples: + - digital-letters-reporting-generate-report-data.schema.yaml + data: + $ref: ../data/digital-letters-reporting-generate-report-data.schema.yaml + description: Example payload wrapper containing notify-payload. diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.generated.v1.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.generated.v1.schema.yaml new file mode 100644 index 000000000..92ee9a949 --- /dev/null +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.generated.v1.schema.yaml @@ -0,0 +1,23 @@ +$schema: https://json-schema.org/draft/2020-12/schema +title: ReportGenerated +type: object +allOf: + - $ref: ../digital-letters-reporting-profile.schema.yaml +properties: + type: + type: string + const: uk.nhs.notify.digital.letters.reporting.report.generated.v1 + description: Concrete versioned event type string for this event (.vN suffix). + source: + type: string + pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/reporting + description: Event source for digital letters. + + dataschema: + type: string + const: ../data/digital-letters-reporting-report-generated-data.schema.yaml + description: Canonical URI of the event's data schema. + examples: + - digital-letters-reporting-report-generated-data.schema.yaml + data: + $ref: ../data/digital-letters-reporting-report-generated-data.schema.yaml diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.sent.v1.schema.yaml similarity index 72% rename from src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1.schema.yaml rename to src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.sent.v1.schema.yaml index 67448e810..33a3c5b1d 100644 --- a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1.schema.yaml +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.sent.v1.schema.yaml @@ -1,22 +1,22 @@ $schema: https://json-schema.org/draft/2020-12/schema -title: DailyReportGenerated +title: ReportSent type: object allOf: - $ref: ../digital-letters-reporting-profile.schema.yaml properties: type: type: string - const: uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1 - description: Concrete versioned event type string for this example event (.vN suffix). + const: uk.nhs.notify.digital.letters.reporting.report.generated.v1 + description: Concrete versioned event type string for this event (.vN suffix). source: type: string pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/reporting - description: Event source for digital letters examples. + description: Event source for digital letters. dataschema: type: string const: ../data/digital-letter-base-data.schema.yaml - description: Canonical URI of the example event's data schema. + description: Canonical URI of the event's data schema. examples: - digital-letter-base-data.schema.yaml data: diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1.schema.yaml similarity index 83% rename from src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1.schema.yaml rename to src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1.schema.yaml index 11dd23e21..8ee111c10 100644 --- a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1.schema.yaml +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1.schema.yaml @@ -7,16 +7,15 @@ properties: type: type: string const: uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1 - description: Concrete versioned event type string for this example event (.vN suffix). + description: Concrete versioned event type string for this event (.vN suffix). source: type: string pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/reporting - description: Event source for digital letters examples. - + description: Event source for digital letters. dataschema: type: string const: ../data/digital-letter-base-data.schema.yaml - description: Canonical URI of the example event's data schema. + description: Canonical URI of the event's data schema. examples: - digital-letter-base-data.schema.yaml data: diff --git a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1.schema.yaml b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1.schema.yaml index 3c7eb6604..956bf6286 100644 --- a/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1.schema.yaml +++ b/src/cloudevents/domains/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1.schema.yaml @@ -7,18 +7,17 @@ properties: type: type: string const: uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1 - description: Concrete versioned event type string for this example event (.vN suffix). + description: Concrete versioned event type string for this event (.vN suffix). source: type: string pattern: ^/nhs/england/notify/(production|staging|development|uat)/(primary|secondary|dev-[0-9]+)/data-plane/digitalletters/viewer - description: Event source for digital letters examples. + description: Event source for digital letters. dataschema: type: string - const: ../data/digital-letter-base-data.schema.yaml - description: Canonical URI of the example event's data schema. + const: ../data/digital-letters-digital-letter-read-data.schema.yaml + description: Canonical URI of the event's data schema. examples: - - digital-letter-base-data.schema.yaml + - digital-letters-digital-letter-read-data.schema.yaml data: - $ref: ../data/digital-letter-base-data.schema.yaml - description: Example payload wrapper containing notify-payload. + $ref: ../data/digital-letters-digital-letter-read-data.schema.yaml diff --git a/src/cloudevents/readme-index.yaml b/src/cloudevents/readme-index.yaml index 2608c5ef6..c822589dd 100644 --- a/src/cloudevents/readme-index.yaml +++ b/src/cloudevents/readme-index.yaml @@ -3,7 +3,7 @@ # To regenerate, run: make update-readme # To customize labels and purposes, edit: readme-metadata.yaml -generated: '2025-11-14T13:43:12.216Z' +generated: '2025-11-17T18:22:19.926Z' common: null domains: - name: digital-letters @@ -22,6 +22,11 @@ domains: source: src/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.yaml published: schemas/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.json docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letter-base-data.schema.md + - type: Digital Letters Digital Letter Read Data + category: data + source: src/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.yaml + published: schemas/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-digital-letter-read-data.schema.md - type: Digital Letters Mesh Inbox Message Downloaded Data category: data source: src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-downloaded-data.schema.yaml @@ -32,6 +37,16 @@ domains: source: src/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.yaml published: schemas/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.json docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-mesh-inbox-message-received-data.schema.md + - type: Digital Letters Message Request Failed Data + category: data + source: src/digital-letters/2025-10-draft/data/digital-letters-message-request-failed-data.schema.yaml + published: schemas/digital-letters/2025-10-draft/data/digital-letters-message-request-failed-data.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-message-request-failed-data.schema.md + - type: Digital Letters Message Request Submitted Data + category: data + source: src/digital-letters/2025-10-draft/data/digital-letters-message-request-submitted-data.schema.yaml + published: schemas/digital-letters/2025-10-draft/data/digital-letters-message-request-submitted-data.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-message-request-submitted-data.schema.md - type: Digital Letters Pdm Resource Available Data category: data source: src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-available-data.schema.yaml @@ -57,11 +72,46 @@ domains: source: src/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.yaml published: schemas/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.json docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-pdm-resource-unavailable-data.schema.md - - type: Messages.status.updated Data.v1 + - type: Digital Letters Queue Item Dequeued Data + category: data + source: src/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.yaml + published: schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-dequeued-data.schema.md + - type: Digital Letters Queue Item Enqueued Data + category: data + source: src/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.yaml + published: schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-enqueued-data.schema.md + - type: Digital Letters Queue Item Removed Data + category: data + source: src/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.yaml + published: schemas/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-queue-item-removed-data.schema.md + - type: Digital Letters Reporting Generate Report Data + category: data + source: src/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.yaml + published: schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-generate-report-data.schema.md + - type: Digital Letters Reporting Report Generated Data category: data - source: src/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.yaml - published: schemas/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.json - docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/messages.status.updated-data.v1.schema.md + source: src/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.yaml + published: schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-report-generated-data.schema.md + - type: Digital Letters Reporting Report Sent Data + category: data + source: src/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.yaml + published: schemas/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/data/digital-letters-reporting-report-sent-data.schema.md + - type: Core + category: definitions + source: src/digital-letters/2025-10-draft/defs/core.schema.yaml + published: schemas/digital-letters/2025-10-draft/defs/core.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/defs/core.schema.md + - type: Mesh + category: definitions + source: src/digital-letters/2025-10-draft/defs/mesh.schema.yaml + published: schemas/digital-letters/2025-10-draft/defs/mesh.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/defs/mesh.schema.md - type: Message Id category: definitions source: src/digital-letters/2025-10-draft/defs/message-id.schema.yaml @@ -77,6 +127,11 @@ domains: source: src/digital-letters/2025-10-draft/defs/pdm.schema.yaml published: schemas/digital-letters/2025-10-draft/defs/pdm.schema.json docs: ../../docs/cloudevents/digital-letters/2025-10-draft/defs/pdm.schema.md + - type: Reporting + category: definitions + source: src/digital-letters/2025-10-draft/defs/reporting.schema.yaml + published: schemas/digital-letters/2025-10-draft/defs/reporting.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/defs/reporting.schema.md - type: Requests category: definitions source: src/digital-letters/2025-10-draft/defs/requests.schema.yaml @@ -237,16 +292,26 @@ domains: source: src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.timer.expired.v1.schema.yaml published: schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.timer.expired.v1.schema.json docs: ../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.queue.timer.expired.v1.schema.md - - type: Uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1 + - type: Uk.nhs.notify.digital.letters.reporting.generate.report.v1 + category: events + source: src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.generate.report.v1.schema.yaml + published: schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.generate.report.v1.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.generate.report.v1.schema.md + - type: Uk.nhs.notify.digital.letters.reporting.report.generated.v1 + category: events + source: src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.generated.v1.schema.yaml + published: schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.generated.v1.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.generated.v1.schema.md + - type: Uk.nhs.notify.digital.letters.reporting.report.sent.v1 category: events - source: src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1.schema.yaml - published: schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1.schema.json - docs: ../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1.schema.md - - type: Uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1 + source: src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.sent.v1.schema.yaml + published: schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.sent.v1.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.sent.v1.schema.md + - type: Uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1 category: events - source: src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1.schema.yaml - published: schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1.schema.json - docs: ../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1.schema.md + source: src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1.schema.yaml + published: schemas/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1.schema.json + docs: ../../docs/cloudevents/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1.schema.md - type: Uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1 category: events source: src/digital-letters/2025-10-draft/events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1.schema.yaml @@ -344,14 +409,22 @@ domains: filename: uk.nhs.notify.digital.letters.queue.timer.expired.v1-event json: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.timer.expired.v1-event.json markdown: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.queue.timer.expired.v1-event.md - - name: Uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1 - filename: uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1-event - json: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1-event.json - markdown: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.daily.report.generated.v1-event.md - - name: Uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1 - filename: uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1-event - json: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1-event.json - markdown: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.daily.report.timer.expired.v1-event.md + - name: Uk.nhs.notify.digital.letters.reporting.generate.report.v1 + filename: uk.nhs.notify.digital.letters.reporting.generate.report.v1-event + json: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.generate.report.v1-event.json + markdown: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.generate.report.v1-event.md + - name: Uk.nhs.notify.digital.letters.reporting.report.generated.v1 + filename: uk.nhs.notify.digital.letters.reporting.report.generated.v1-event + json: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.generated.v1-event.json + markdown: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.generated.v1-event.md + - name: Uk.nhs.notify.digital.letters.reporting.report.sent.v1 + filename: uk.nhs.notify.digital.letters.reporting.report.sent.v1-event + json: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.sent.v1-event.json + markdown: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.sent.v1-event.md + - name: Uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1 + filename: uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1-event + json: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1-event.json + markdown: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.reporting.report.timer.expired.v1-event.md - name: Uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1 filename: uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1-event json: ../../docs/cloudevents/digital-letters/2025-10-draft/example-events/uk.nhs.notify.digital.letters.viewer.digital.letter.read.v1-event.json