5 Commits

Author SHA1 Message Date
e7e2093054 Add 'm' key for 'mode' to be set only when the service is a Ship or Bus.
All checks were successful
Generate and Release Protos / release (push) Successful in 39s
2026-05-10 19:29:14 +01:00
12db4b79fd Fix formatting
All checks were successful
Generate and Release Protos / release (push) Successful in 41s
2026-05-08 19:06:41 +01:00
eb6d90bbb8 Add service data for 'False Destination' and 'Via text'.
Add envelope support for PUBLIC/STAFF enum for display decisions
2026-05-08 19:06:14 +01:00
5918cc54a8 Extend board to include passing times
All checks were successful
Generate and Release Protos / release (push) Successful in 39s
2026-05-07 14:11:53 +01:00
3b1a9a2be1 Reorganise the board JSON response
All checks were successful
Generate and Release Protos / release (push) Successful in 38s
2026-05-07 13:02:51 +01:00
2 changed files with 95 additions and 12 deletions

View File

@@ -10,6 +10,12 @@
"minimum": 0,
"description": "Unix timestamp showing when the data was generated, or the time the error was encountered"
},
"p": {
"type": "string",
"title": "Privilege Type",
"description": "Whether the data is public or staff, omitted where no differences",
"enum": ["public", "staff"]
},
"d": {
"description": "Payload data. Type depends on request endpoint, typically an array of the response type"
},

View File

@@ -5,15 +5,10 @@
"description": "Arr/Dep/Pass Board",
"type": "object",
"properties": {
"n": {
"type": "string",
"title": "Location Name",
"description": "The name of the location"
},
"o": {
"type": "string",
"title": "Operator (if station)",
"description": "The operator of the station, if the location is a station"
"d": {
"title": "Metadata",
"type": "object",
"$ref": "#/definitions/metadata"
},
"s": {
"title": "Services",
@@ -34,6 +29,25 @@
"n"
],
"definitions": {
"metadata": {
"type": "object",
"required": [
"n",
"o"
],
"properties": {
"n": {
"type": "string",
"title": "Location Name",
"description": "The name of the location"
},
"o": {
"type": "string",
"title": "Station Operator",
"description": "The operator of the station (not present for location)"
}
}
},
"boardService": {
"type": "object",
"required": [
@@ -49,6 +63,12 @@
"title": "RID",
"description": "Services RID"
},
"m": {
"type": "string",
"title": "mode",
"description": "Transport mode, default value: Train",
"enum": ["SHIP", "BUS"]
},
"o": {
"type": "string",
"title": "TOC",
@@ -63,7 +83,10 @@
"type": "object",
"title": "Origin",
"description": "The services origin",
"required": ["t", "n"],
"required": [
"t",
"n"
],
"properties": {
"t": {
"type": "string",
@@ -81,7 +104,10 @@
"type": "object",
"title": "Destination",
"description": "The services destination",
"required": ["t", "n"],
"required": [
"t",
"n"
],
"properties": {
"t": {
"type": "string",
@@ -95,6 +121,37 @@
}
}
},
"h": {
"type": "string",
"title": "Headcode",
"description": "The headcode of the service"
},
"fd": {
"type": "object",
"title": "False Destination",
"description": "False destination should be preferred on public boards",
"required": [
"t",
"n"
],
"properties": {
"t": {
"type": "string",
"title": "TIPLOC",
"description": "The Destination TIPLOC"
},
"n": {
"type": "string",
"title": "Name",
"description": "The Destination Name"
}
}
},
"v": {
"type": "string",
"title": "via Text",
"description": "via text that should be displayed if present"
},
"sta": {
"type": "string",
"format": "date-time",
@@ -131,6 +188,24 @@
"title": "Estimated Departure",
"description": "The estimated departure time of the service"
},
"wtp": {
"type": "string",
"format": "date-time",
"title": "Scheduled Pass",
"description": "The scheduled pass time of the service"
},
"atp": {
"type": "string",
"format": "date-time",
"title": "Actual Pass",
"description": "The actual pass time of the service"
},
"etp": {
"type": "string",
"format": "date-time",
"title": "Estimated Pass",
"description": "The estimated pass time of the service"
},
"p": {
"type": "string",
"title": "Platform",
@@ -209,7 +284,9 @@
},
"boardMsgs": {
"type": "object",
"required": ["t"],
"required": [
"t"
],
"properties": {
"t": {
"type": "string",