Files
backend-data-contracts/schemas/data-ingress/mq-file-update.json
Fred Boniface a927ccc732
All checks were successful
Generate and Release Protos / release (push) Successful in 30s
Add additional file types ready for declaration
2026-01-13 18:40:16 +00:00

43 lines
1.6 KiB
JSON

{
"$id": "https://schema.owlboard.info/data-ingress/mq-file-update.schema.json",
"$schema": "https://json-schema.org/draft-07/schema#",
"title": "MQFileUpdate",
"type": "object",
"properties": {
"service_name": {
"type": "string",
"description": "Name of the service submitting the update"
},
"data_type": {
"type": "string",
"enum": ["file"],
"description": "The type of data contained in this message object"
},
"sent_timestamp": {
"type": "integer",
"description": "Unix timestamp representing the time the message was sent"
},
"data_kind": {
"type": "string",
"enum": ["pis", "timetable", "knowledgebase"],
"description": "The data type contained in the file. Currently supported PIS: PIS Data, Timetable: CIF or VSTP Data, Knowledgebase: Station Data"
},
"payload": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "The version string from the package source"
},
"filepath": {
"type": "string",
"description": "The full path to the file, including protocol (eg. s3://) where appropriate"
}
},
"required": ["version", "filepath"],
"additionalProperties": false
}
},
"required": ["service_name", "data_type", "sent_timestamp", "data_kind", "payload"],
"additionalProperties": false
}