diff --git a/specification/schemas/components/MessageStatus.yaml b/specification/schemas/components/MessageStatus.yaml index 9ec05ebe4..0a89c165a 100644 --- a/specification/schemas/components/MessageStatus.yaml +++ b/specification/schemas/components/MessageStatus.yaml @@ -43,6 +43,11 @@ properties: example: '2023-11-17T14:27:51.413Z' routingPlan: $ref: ../types/RoutingPlan.yaml + metadata: + type: array + minItems: 1 + items: + $ref: ../types/Metadata.yaml required: - messageId - messageReference diff --git a/specification/schemas/types/Metadata.yaml b/specification/schemas/types/Metadata.yaml new file mode 100644 index 000000000..3aeb107f0 --- /dev/null +++ b/specification/schemas/types/Metadata.yaml @@ -0,0 +1,18 @@ +type: object +additionalProperties: false +properties: + version: + type: string + description: The version identifier of the source data at the time it was queried + example: '2' + queriedAt: + type: date-time + description: The timestamp when the source was queried + example: '2023-11-17T14:27:51.413Z' + source: + type: string + description: This identifies the source of the metadata. This is a free text field and can be used to identify the system that provided the metadata. + example: 'pds' +required: + - queriedAt + - source