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

Compare commits

base: OwlBoard:v0.1.18
Branches Tags
OwlBoard:main
OwlBoard:v0.1.19 OwlBoard:v0.1.18 OwlBoard:v0.1.17 OwlBoard:v0.1.16 OwlBoard:v0.1.15 OwlBoard:v0.1.14 OwlBoard:v0.1.13 OwlBoard:v0.1.12 OwlBoard:v0.1.11 OwlBoard:v0.1.10 OwlBoard:v0.1.9 OwlBoard:v0.1.8 OwlBoard:v0.1.7 OwlBoard:v0.1.6 OwlBoard:v0.1.5 OwlBoard:v0.1.4 OwlBoard:v0.1.3 OwlBoard:v0.1.2 OwlBoard:v0.1.1 OwlBoard:v0.1.0 OwlBoard:v0.0.4 OwlBoard:v0.0.3 OwlBoard:v0.0.2 OwlBoard:v0.0.1
..
compare: OwlBoard:main
Branches Tags
OwlBoard:main
OwlBoard:v0.1.19 OwlBoard:v0.1.18 OwlBoard:v0.1.17 OwlBoard:v0.1.16 OwlBoard:v0.1.15 OwlBoard:v0.1.14 OwlBoard:v0.1.13 OwlBoard:v0.1.12 OwlBoard:v0.1.11 OwlBoard:v0.1.10 OwlBoard:v0.1.9 OwlBoard:v0.1.8 OwlBoard:v0.1.7 OwlBoard:v0.1.6 OwlBoard:v0.1.5 OwlBoard:v0.1.4 OwlBoard:v0.1.3 OwlBoard:v0.1.2 OwlBoard:v0.1.1 OwlBoard:v0.1.0 OwlBoard:v0.0.4 OwlBoard:v0.0.3 OwlBoard:v0.0.2 OwlBoard:v0.0.1

1 Commits
v0.1.18 ... main

Author SHA1 Message Date
Fred Boniface
4ab05ba738 Adjust declarations and remove uses of the allOf function to assist with type generation
All checks were successful
Generate and Release Protos / release (push) Successful in 38s
Details
2026-02-27 20:18:57 +00:00
2 changed files with 223 additions and 129 deletions
Expand all files Collapse all files

352
schemas/data-ingress/pushport/16schedule.json
View File

@@ -4,12 +4,13 @@
"title": "PushPortSchedule", "title": "PushPortSchedule",
"description": "Consolidated object definition for Darwin Schedule messages", "description": "Consolidated object definition for Darwin Schedule messages",
"definitions": { "definitions": {
"SchedLocAttributes": { "originPoint": {
"type": "object", "description": "Merged Origin (OR / OPOR). The starting point of the journey.",
"description": "Attributes common to all schedule locations",
"required": [ "required": [
"wtd",
"tpl" "tpl"
], ],
"type": "object",
"properties": { "properties": {
"tpl": { "tpl": {
"type": "string", "type": "string",
@@ -32,13 +33,7 @@
"fid": { "fid": {
"type": "string", "type": "string",
"description": "Unique identifier of the formation data (v3) " "description": "Unique identifier of the formation data (v3) "
} },
}
},
"CallPtAttributes": {
"type": "object",
"description": "Attributes for Calling Points (Optional for Operational variants)",
"properties": {
"pta": { "pta": {
"type": "string", "type": "string",
"description": "Public Scheduled Time of Arrival" "description": "Public Scheduled Time of Arrival"
@@ -50,134 +45,181 @@
"avgLoading": { "avgLoading": {
"type": "string", "type": "string",
"description": "Average Loading value based on long-term averages (v3) " "description": "Average Loading value based on long-term averages (v3) "
},
"wta": {
"type": "string",
"description": "Working Scheduled Time of Arrival (Optional)"
},
"wtd": {
"type": "string",
"description": "Working Scheduled Time of Departure (Required)"
},
"fd": {
"type": "string",
"description": "False Destination TIPLOC (Passenger only)"
} }
} }
}, },
"originPoint": {
"description": "Merged Origin (OR / OPOR). The starting point of the journey.",
"required": [
"wtd"
],
"allOf": [
{
"$ref": "#/definitions/SchedLocAttributes"
},
{
"$ref": "#/definitions/CallPtAttributes"
},
{
"type": "object",
"properties": {
"wta": {
"type": "string",
"description": "Working Scheduled Time of Arrival (Optional)"
},
"wtd": {
"type": "string",
"description": "Working Scheduled Time of Departure (Required)"
},
"fd": {
"type": "string",
"description": "False Destination TIPLOC (Passenger only)"
}
}
}
]
},
"callingPoint": { "callingPoint": {
"description": "Merged Intermediate Point (IP / OPIP). An intermediate stop requiring dwell time.", "description": "Merged Intermediate Point (IP / OPIP). An intermediate stop requiring dwell time.",
"required": [ "required": [
"wta", "wta",
"wtd" "wtd",
"tpl"
], ],
"allOf": [ "type": "object",
{ "properties": {
"$ref": "#/definitions/SchedLocAttributes" "tpl": {
"type": "string",
"description": "TIPLOC"
}, },
{ "act": {
"$ref": "#/definitions/CallPtAttributes" "type": "string",
"default": " ",
"description": "Current Activity Codes"
}, },
{ "planAct": {
"type": "object", "type": "string",
"properties": { "description": "Planned Activity Codes"
"wta": { },
"type": "string", "can": {
"description": "Working Scheduled Time of Arrival (Required)" "type": "boolean",
}, "default": false,
"wtd": { "description": "Cancelled flag"
"type": "string", },
"description": "Working Scheduled Time of Departure (Required)" "fid": {
}, "type": "string",
"rdelay": { "description": "Unique identifier of the formation data (v3) "
"type": "integer", },
"default": 0, "pta": {
"description": "Route delay value" "type": "string",
}, "description": "Public Scheduled Time of Arrival"
"fd": { },
"type": "string", "ptd": {
"description": "False Destination (Passenger only)" "type": "string",
} "description": "Public Scheduled Time of Departure"
} },
"avgLoading": {
"type": "string",
"description": "Average Loading value based on long-term averages (v3) "
},
"wta": {
"type": "string",
"description": "Working Scheduled Time of Arrival (Required)"
},
"wtd": {
"type": "string",
"description": "Working Scheduled Time of Departure (Required)"
},
"rdelay": {
"type": "integer",
"default": 0,
"description": "Route delay value"
},
"fd": {
"type": "string",
"description": "False Destination (Passenger only)"
} }
] }
}, },
"passPoint": { "passPoint": {
"description": "Intermediate Passing Point (PP). Purely operational.", "description": "Intermediate Passing Point (PP). Purely operational.",
"required": [ "required": [
"wtp" "wtp",
"tpl"
], ],
"allOf": [ "type": "object",
{ "properties": {
"$ref": "#/definitions/SchedLocAttributes" "tpl": {
"type": "string",
"description": "TIPLOC"
}, },
{ "act": {
"type": "object", "type": "string",
"properties": { "default": " ",
"wtp": { "description": "Current Activity Codes"
"type": "string", },
"description": "Working Scheduled Time of Passing (Required)" "planAct": {
}, "type": "string",
"rdelay": { "description": "Planned Activity Codes"
"type": "integer", },
"default": 0, "can": {
"description": "Route delay value" "type": "boolean",
} "default": false,
}, "description": "Cancelled flag"
"additionalProperties": false },
"fid": {
"type": "string",
"description": "Unique identifier of the formation data (v3) "
},
"wtp": {
"type": "string",
"description": "Working Scheduled Time of Passing (Required)"
},
"rdelay": {
"type": "integer",
"default": 0,
"description": "Route delay value"
} }
] },
"additionalProperties": false
}, },
"destinationPoint": { "destinationPoint": {
"description": "Merged Destination (DT / OPDT). The termination point of the journey.", "description": "Merged Destination (DT / OPDT). The termination point of the journey.",
"required": [ "required": [
"wta" "wta",
"tpl"
], ],
"allOf": [ "type": "object",
{ "properties": {
"$ref": "#/definitions/SchedLocAttributes" "tpl": {
"type": "string",
"description": "TIPLOC"
}, },
{ "act": {
"$ref": "#/definitions/CallPtAttributes" "type": "string",
"default": " ",
"description": "Current Activity Codes"
}, },
{ "planAct": {
"type": "object", "type": "string",
"properties": { "description": "Planned Activity Codes"
"wta": { },
"type": "string", "can": {
"description": "Working Scheduled Time of Arrival (Required)" "type": "boolean",
}, "default": false,
"wtd": { "description": "Cancelled flag"
"type": "string", },
"description": "Working Scheduled Time of Departure (Optional)" "fid": {
}, "type": "string",
"rdelay": { "description": "Unique identifier of the formation data (v3) "
"type": "integer", },
"default": 0, "pta": {
"description": "Route delay value" "type": "string",
} "description": "Public Scheduled Time of Arrival"
} },
"ptd": {
"type": "string",
"description": "Public Scheduled Time of Departure"
},
"avgLoading": {
"type": "string",
"description": "Average Loading value based on long-term averages (v3) "
},
"wta": {
"type": "string",
"description": "Working Scheduled Time of Arrival (Required)"
},
"wtd": {
"type": "string",
"description": "Working Scheduled Time of Departure (Optional)"
},
"rdelay": {
"type": "integer",
"default": 0,
"description": "Route delay value"
} }
] }
} }
}, },
"type": "object", "type": "object",
@@ -215,42 +257,94 @@
"locations" "locations"
], ],
"properties": { "properties": {
"rid": {"type": "string", "description": "Rail Identifier - Unique value for the service"}, "rid": {
"uid": {"type": "string", "description": "Unique ID - Unique value for the timetable entry - maps to Network Rail CIF schedules"}, "type": "string",
"ssd": {"type": "string", "format": "date", "description": "Service Start Date - The date the service commences"}, "description": "Rail Identifier - Unique value for the service"
"trainId": {"type": "string", "description": "Headcode"}, },
"toc": {"type": "string", "minLength": 2, "maxLength": 2, "description": "Train Operator (ATOC Code)"}, "uid": {
"rsid": {"type": "string", "description": "Retail Service ID"}, "type": "string",
"status": {"type": "string", "default": "P", "description": "P = Permanent, L = Long Term, S = Short Term"}, "description": "Unique ID - Unique value for the timetable entry - maps to Network Rail CIF schedules"
"trainCat": {"type": "string", "default": "OO", "description": "Train Category"}, },
"isPassenger": {"type": "boolean", "default": true, "description": "Declares the service as a passenger service"}, "ssd": {
"isActive": {"type": "boolean", "default": false, "description": "UNKNOWN"}, "type": "string",
"isCharter": {"type": "boolean", "default": false, "description": "Declares the service as a charter service"}, "format": "date",
"cancelReason": {"type": "integer", "description": "Cancellation Reason code"}, "description": "Service Start Date - The date the service commences"
},
"trainId": {
"type": "string",
"description": "Headcode"
},
"toc": {
"type": "string",
"minLength": 2,
"maxLength": 2,
"description": "Train Operator (ATOC Code)"
},
"rsid": {
"type": "string",
"description": "Retail Service ID"
},
"status": {
"type": "string",
"default": "P",
"description": "P = Permanent, L = Long Term, S = Short Term"
},
"trainCat": {
"type": "string",
"default": "OO",
"description": "Train Category"
},
"isPassenger": {
"type": "boolean",
"default": true,
"description": "Declares the service as a passenger service"
},
"isActive": {
"type": "boolean",
"default": false,
"description": "UNKNOWN"
},
"isCharter": {
"type": "boolean",
"default": false,
"description": "Declares the service as a charter service"
},
"cancelReason": {
"type": "integer",
"description": "Cancellation Reason code"
},
"locations": { "locations": {
"type": "object", "type": "object",
"additionalProperties": false,
"description": "Merged and flattened location objects", "description": "Merged and flattened location objects",
"properties": { "properties": {
"OR": { "OR": {
"type": "array", "type": "array",
"description": "OR/OPOR Values - Trains Origin", "description": "OR/OPOR Values - Trains Origin",
"items": {"$ref": "#/definitions/originPoint"} "items": {
"$ref": "#/definitions/originPoint"
}
}, },
"IP": { "IP": {
"type": "array", "type": "array",
"description": "IP/OPIP Values - Intermediate Points", "description": "IP/OPIP Values - Intermediate Points",
"items": {"$ref": "#/definitions/callingPoint"} "items": {
"$ref": "#/definitions/callingPoint"
}
}, },
"PP": { "PP": {
"type": "array", "type": "array",
"description": "Passing Points (Non-stop)", "description": "Passing Points (Non-stop)",
"items": {"$ref": "#/definitions/passPoint"} "items": {
"$ref": "#/definitions/passPoint"
}
}, },
"DT": { "DT": {
"type": "array", "type": "array",
"description": "DT/OPDT Values - Trains Destination", "description": "DT/OPDT Values - Trains Destination",
"items": {"$ref": "#/definitions/destinationPoint"} "items": {
"$ref": "#/definitions/destinationPoint"
}
} }
} }
} }

0
schemas/data-ingress/pushport/helper
View File