Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 770ee003e7 | |||
| a5675b1442 | |||
| a927ccc732 | |||
| 817c338745 |
32
schemas/data-ingress/message-envelope.json
Normal file
32
schemas/data-ingress/message-envelope.json
Normal file
@@ -0,0 +1,32 @@
|
||||
{
|
||||
"$id": "https://schema.owlboard.info/data-ingress/message-envelope.schema.json",
|
||||
"$schema": "https://json-schema.org/draft-07/schema#",
|
||||
"title": "MessageEnvelope",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"service_name": {
|
||||
"type": "string",
|
||||
"description": "Name of the service submitting the update"
|
||||
},
|
||||
"service_id": {
|
||||
"type": "string",
|
||||
"description": "ID of the service sending the message - usually a hostname"
|
||||
},
|
||||
"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 message. Currently supported PIS: PIS Data, Timetable: CIF or VSTP Data, Knowledgebase: Station Data"
|
||||
}
|
||||
},
|
||||
"required": ["service_name", "service_id", "data_type", "sent_timestamp"],
|
||||
"additionalProperties": true
|
||||
}
|
||||
@@ -8,23 +8,27 @@
|
||||
"type": "string",
|
||||
"description": "Name of the service submitting the update"
|
||||
},
|
||||
"update_type": {
|
||||
"service_id": {
|
||||
"type": "string",
|
||||
"description": "ID of the service sending the message - usually a hostname"
|
||||
},
|
||||
"data_type": {
|
||||
"type": "string",
|
||||
"enum": ["file"],
|
||||
"description": "The method of update application"
|
||||
"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": {
|
||||
"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"
|
||||
@@ -34,9 +38,10 @@
|
||||
"description": "The full path to the file, including protocol (eg. s3://) where appropriate"
|
||||
}
|
||||
},
|
||||
"required": ["kind", "version", "filepath"]
|
||||
}
|
||||
},
|
||||
"required": ["service_name", "update_type", "payload"],
|
||||
"required": ["version", "filepath"],
|
||||
"additionalProperties": false
|
||||
}
|
||||
},
|
||||
"required": ["service_name", "service_id", "data_type", "sent_timestamp", "data_kind", "payload"],
|
||||
"additionalProperties": false
|
||||
}
|
||||
Reference in New Issue
Block a user