OwlBoard/backend-data-contracts
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add darwin association data type
All checks were successful
Generate and Release Protos / release (push) Successful in 44s
Details

Browse Source
This commit is contained in:
Fred Boniface
2026-04-05 20:13:14 +01:00
parent e7f307f243
commit a734dea17a
1 changed files with 118 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
schemas/data-ingress/darwin-data/darwin-association.json Normal file
View File

@@ -0,0 +1,118 @@
{
"$id": "https://schema.owlboard.info/data-ingress/darwin/association.schema.json",
"$schema": "https://json-schema.org/draft-07/schema#",
"title": "DarwinAssocData",
"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",
"const": "raw",
"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",
"const": "darwin-association",
"description": "The data type contained in the message. Currently supported PIS: PIS Data, Timetable: CIF or VSTP Data, Knowledgebase: Station Data"
},
"payload": {
"type": "array",
"additionalItems": false,
"items": {
"type": "object",
"additionalProperties": false,
"required": [
"mr",
"ar",
"t",
"c",
"s",
"mt",
"at"
],
"properties": {
"mr": {
"type": "string",
"name": "Main RID",
"description": "The main RID of this association object"
},
"ar": {
"type": "string",
"name": "Associated RID",
"description": "The associated RID of this association object"
},
"t": {
"type": "string",
"name": "TIPLOC",
"description": "The location at which this association applies"
},
"c": {
"enum": ["JJ", "VV", "LK", "NP"],
"name": "Category",
"description": "The type of association"
},
"s": {
"type": "string",
"format": "date",
"name": "SSD",
"description": "SSD Generated from the Main RID"
},
"mt": {
"name": "Main Times",
"description": "Timings that apply to the main RID",
"type": "object",
"properties": {
"wta": { "type": "string", "format": "date-time" },
"wtd": { "type": "string", "format": "date-time" },
"wtp": { "type": "string", "format": "date-time" },
"pta": { "type": "string", "format": "date-time" },
"ptd": { "type": "string", "format": "date-time" }
}
},
"at": {
"name": "Associated Times",
"description": "Timings that apply to the associated RID",
"type": "object",
"properties": {
"wta": { "type": "string", "format": "date-time" },
"wtd": { "type": "string", "format": "date-time" },
"wtp": { "type": "string", "format": "date-time" },
"pta": { "type": "string", "format": "date-time" },
"ptd": { "type": "string", "format": "date-time" }
}
},
"can": {
"name": "Cancelled",
"type": "boolean",
"description": "Whether this association is cancelled"
},
"del": {
"name": "Deleted",
"type": "boolean",
"description": "Whether this association is deleted"
}
}
}
}
},
"required": [
"service_name",
"service_id",
"data_type",
"data_kind",
"sent_timestamp",
"payload"
],
"additionalProperties": false
}