diff --git a/schemas/data-ingress/mq-file-update.json b/schemas/data-ingress/mq-file-update.json new file mode 100644 index 0000000..37a3922 --- /dev/null +++ b/schemas/data-ingress/mq-file-update.json @@ -0,0 +1,42 @@ +{ + "$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" + }, + "update_type": { + "type": "string", + "enum": ["file"], + "description": "The method of update application" + }, + "sent_timestamp": { + "type": "integer", + "description": "Unix timestamp representing the time the message was sent" + }, + "payload": { + "type": "object", + "properties": { + "kind": { + "type": "string", + "enum": ["pis"], + "description": "The type of data provided in the update" + }, + "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": ["kind", "version", "filepath"] + } + }, + "required": ["service_name", "update_type", "payload"], + "additionalProperties": false +} \ No newline at end of file