Compare commits
16 Commits
v3.0.3-alp
...
v3.0.3-alp
| Author | SHA1 | Date | |
|---|---|---|---|
| 12db4b79fd | |||
| eb6d90bbb8 | |||
| 5918cc54a8 | |||
| 3b1a9a2be1 | |||
| b8c773c3c9 | |||
| a7fe008fee | |||
| 6cfc12b538 | |||
| 53ce528d56 | |||
| 25c1793df3 | |||
| 48f1a31378 | |||
| 376370c729 | |||
| 180886fd68 | |||
| 513196c43d | |||
| 5d4271c193 | |||
| c02ff3ebab | |||
| 519acebcba |
@@ -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"
|
||||
},
|
||||
|
||||
303
schemas/api/stations/board.json
Normal file
303
schemas/api/stations/board.json
Normal file
@@ -0,0 +1,303 @@
|
||||
{
|
||||
"$id": "https://schema.owlboard.info/api/stations/board.schema.json",
|
||||
"$schema": "https://json-schema.org/draft-07/schema#",
|
||||
"title": "StationsBoard",
|
||||
"description": "Arr/Dep/Pass Board",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"d": {
|
||||
"title": "Metadata",
|
||||
"type": "object",
|
||||
"$ref": "#/definitions/metadata"
|
||||
},
|
||||
"s": {
|
||||
"title": "Services",
|
||||
"type": "array",
|
||||
"items": {
|
||||
"$ref": "#/definitions/boardService"
|
||||
}
|
||||
},
|
||||
"m": {
|
||||
"type": "array",
|
||||
"title": "messages",
|
||||
"items": {
|
||||
"$ref": "#/definitions/boardMsgs"
|
||||
}
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"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": [
|
||||
"r",
|
||||
"o",
|
||||
"ip",
|
||||
"og",
|
||||
"dt"
|
||||
],
|
||||
"properties": {
|
||||
"r": {
|
||||
"type": "string",
|
||||
"title": "RID",
|
||||
"description": "Services RID"
|
||||
},
|
||||
"o": {
|
||||
"type": "string",
|
||||
"title": "TOC",
|
||||
"description": "The services operator code"
|
||||
},
|
||||
"ip": {
|
||||
"type": "boolean",
|
||||
"title": "isPassenger",
|
||||
"description": "Whether this is a passenger service"
|
||||
},
|
||||
"og": {
|
||||
"type": "object",
|
||||
"title": "Origin",
|
||||
"description": "The services origin",
|
||||
"required": [
|
||||
"t",
|
||||
"n"
|
||||
],
|
||||
"properties": {
|
||||
"t": {
|
||||
"type": "string",
|
||||
"title": "TIPLOC",
|
||||
"description": "The Origin TIPLOC"
|
||||
},
|
||||
"n": {
|
||||
"type": "string",
|
||||
"title": "Name",
|
||||
"description": "The Origin Name"
|
||||
}
|
||||
}
|
||||
},
|
||||
"dt": {
|
||||
"type": "object",
|
||||
"title": "Destination",
|
||||
"description": "The services destination",
|
||||
"required": [
|
||||
"t",
|
||||
"n"
|
||||
],
|
||||
"properties": {
|
||||
"t": {
|
||||
"type": "string",
|
||||
"title": "TIPLOC",
|
||||
"description": "The Destination TIPLOC"
|
||||
},
|
||||
"n": {
|
||||
"type": "string",
|
||||
"title": "Name",
|
||||
"description": "The Destination Name"
|
||||
}
|
||||
}
|
||||
},
|
||||
"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",
|
||||
"title": "Scheduled Arrival",
|
||||
"description": "The scheduled arrival time of the service (public or working)"
|
||||
},
|
||||
"ata": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Actual Arrival",
|
||||
"description": "The actual arrival time of the service"
|
||||
},
|
||||
"eta": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Estimated Arrival",
|
||||
"description": "The estimated arrival time of the service"
|
||||
},
|
||||
"std": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Scheduled Departure",
|
||||
"description": "The scheduled departure time of the service (public or working)"
|
||||
},
|
||||
"atd": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Actual Departure",
|
||||
"description": "The actual departure time of the service"
|
||||
},
|
||||
"etd": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"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",
|
||||
"description": "The platform for this service"
|
||||
},
|
||||
"pc": {
|
||||
"type": "boolean",
|
||||
"title": "Platform Changed",
|
||||
"description": "Whether the platform has changed (alteration)"
|
||||
},
|
||||
"ps": {
|
||||
"type": "boolean",
|
||||
"title": "Platform suppressed",
|
||||
"description": "Whether the platform number is suppressed"
|
||||
},
|
||||
"c": {
|
||||
"type": "boolean",
|
||||
"title": "Cancelled",
|
||||
"description": "Whether the service is cancelled at this location"
|
||||
},
|
||||
"da": {
|
||||
"type": "boolean",
|
||||
"title": "Delayed Arrival",
|
||||
"description": "Whether to show the service as delayed arrival"
|
||||
},
|
||||
"dd": {
|
||||
"type": "boolean",
|
||||
"title": "Delayed Departure",
|
||||
"description": "Whether to show the service as delayed departure"
|
||||
},
|
||||
"cr": {
|
||||
"$ref": "#/definitions/reason"
|
||||
},
|
||||
"dr": {
|
||||
"$ref": "#/definitions/reason"
|
||||
},
|
||||
"act": {
|
||||
"type": "string",
|
||||
"title": "Activities",
|
||||
"description": "Activities at this location"
|
||||
},
|
||||
"f": {
|
||||
"$ref": "#/definitions/formation"
|
||||
}
|
||||
}
|
||||
},
|
||||
"reason": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"r": {
|
||||
"type": "string",
|
||||
"title": "Reason",
|
||||
"description": "The textual reason"
|
||||
},
|
||||
"l": {
|
||||
"type": "string",
|
||||
"title": "Location",
|
||||
"description": "The location the reason occurred"
|
||||
},
|
||||
"n": {
|
||||
"type": "boolean",
|
||||
"title": "Near",
|
||||
"description": "Whether the reason occured NEAR LOCATION (else AT LOCATION)"
|
||||
}
|
||||
}
|
||||
},
|
||||
"formation": {
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"fid": {
|
||||
"type": "string",
|
||||
"title": "FID",
|
||||
"description": "The serviced FID at this location"
|
||||
}
|
||||
}
|
||||
},
|
||||
"boardMsgs": {
|
||||
"type": "object",
|
||||
"required": [
|
||||
"t"
|
||||
],
|
||||
"properties": {
|
||||
"t": {
|
||||
"type": "string",
|
||||
"title": "Text",
|
||||
"description": "The message text"
|
||||
},
|
||||
"l": {
|
||||
"type": "string",
|
||||
"title": "Link",
|
||||
"description": "The NRE Link to the incident page"
|
||||
},
|
||||
"lt": {
|
||||
"type": "string",
|
||||
"title": "Link Text",
|
||||
"description": "The text to display as the link"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -36,6 +36,12 @@
|
||||
"description": "The TOC operating the service",
|
||||
"minLength": 2,
|
||||
"maxLength": 2
|
||||
},
|
||||
"ct": {
|
||||
"type": "boolean",
|
||||
"title": "Cancelled Throughout",
|
||||
"name": "Cancelled Throughout",
|
||||
"description": "Whether the train is cancelled throughout"
|
||||
}
|
||||
}
|
||||
}
|
||||
207
schemas/api/trains/TrainDetails.json
Normal file
207
schemas/api/trains/TrainDetails.json
Normal file
@@ -0,0 +1,207 @@
|
||||
{
|
||||
"$schema": "https://json-schema.org/draft-07/schema#",
|
||||
"title": "TrainDetailsResponse",
|
||||
"$defs": {
|
||||
"ServiceLocation": {
|
||||
"type": "object",
|
||||
"description": "A specific location along the services journey",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"t": {
|
||||
"type": "string",
|
||||
"title": "TIPLOC",
|
||||
"description": "The TIPLOC of the location"
|
||||
},
|
||||
"r": {
|
||||
"type": "string",
|
||||
"enum": ["ORIG", "CALL", "PASS", "DEST"],
|
||||
"title": "Location Role",
|
||||
"description": "The role of this location in the journey"
|
||||
},
|
||||
"s": {
|
||||
"type": "integer",
|
||||
"title": "Sequence Number",
|
||||
"description": "The sequence at which this location sits in the schedule"
|
||||
},
|
||||
"act": {
|
||||
"title": "activities",
|
||||
"description": "Activities carried out at this location",
|
||||
"type": "string"
|
||||
},
|
||||
"p": {
|
||||
"title": "Platform",
|
||||
"type": "string",
|
||||
"description": "The platform that this event takes place"
|
||||
},
|
||||
"pc": {
|
||||
"title": "Platform Changed",
|
||||
"type": "boolean"
|
||||
},
|
||||
"pcn": {
|
||||
"title": "Platform Confirmed",
|
||||
"type": "boolean"
|
||||
},
|
||||
"ps": {
|
||||
"title": "Platform Surpressed",
|
||||
"description": "Whether platform data is surpressed",
|
||||
"type": "boolean"
|
||||
},
|
||||
"can": {
|
||||
"title": "Cancelled",
|
||||
"description": "Whether this location is cancelled in the journey",
|
||||
"type": "boolean"
|
||||
},
|
||||
"al": {
|
||||
"type": "integer",
|
||||
"title": "Average Loading",
|
||||
"description": "The average loading at this location"
|
||||
},
|
||||
"fid": {
|
||||
"type": "string",
|
||||
"title": "Formation ID",
|
||||
"description": "The formation ID at this location"
|
||||
},
|
||||
"pta": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Public time of arrival"
|
||||
},
|
||||
"wta": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Working time of arrival"
|
||||
},
|
||||
"wtp": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Working time of pass"
|
||||
},
|
||||
"ptd": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Public time of departure"
|
||||
},
|
||||
"wtd": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Working time of departure"
|
||||
},
|
||||
"eta": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Estimated time of arrival"
|
||||
},
|
||||
"etd": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Estimated time of departure"
|
||||
},
|
||||
"etp": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Estimated time of pass"
|
||||
},
|
||||
"ata": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Actual time of arrival"
|
||||
},
|
||||
"atd": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Actual time of departure"
|
||||
},
|
||||
"atp": {
|
||||
"type": "string",
|
||||
"format": "date-time",
|
||||
"title": "Actual time of pass"
|
||||
}
|
||||
},
|
||||
"required": ["t", "r", "s", "act"]
|
||||
}
|
||||
},
|
||||
"type": "object",
|
||||
"required": ["header", "locations"],
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"header": {
|
||||
"type": "object",
|
||||
"additionalProperties": false,
|
||||
"properties": {
|
||||
"h": {
|
||||
"title": "train_id",
|
||||
"description": "Headcode",
|
||||
"maxLength": 4,
|
||||
"minLength": 4,
|
||||
"type": "string"
|
||||
},
|
||||
"t": {
|
||||
"title": "TOC",
|
||||
"description": "The TOC operating the service",
|
||||
"type": "string",
|
||||
"maxLength": 3,
|
||||
"minLength": 2
|
||||
},
|
||||
"st": {
|
||||
"title": "Status",
|
||||
"description": "Train status",
|
||||
"type": "string"
|
||||
},
|
||||
"cr": {
|
||||
"title": "Cancel Reason",
|
||||
"type": "string"
|
||||
},
|
||||
"cl": {
|
||||
"title": "Cancel Location",
|
||||
"type": "string",
|
||||
"maxLength": 7
|
||||
},
|
||||
"cn": {
|
||||
"title": "Cancel Near",
|
||||
"description": "Whether the train was cancelled NEAR the 'cancel_loation', else at the 'cancel_location'",
|
||||
"type": "boolean"
|
||||
},
|
||||
"dr": {
|
||||
"title": "Delay Reason",
|
||||
"type": "string"
|
||||
},
|
||||
"dl": {
|
||||
"title": "Delay Location",
|
||||
"type": "string",
|
||||
"maxLength": 7
|
||||
},
|
||||
"dn": {
|
||||
"title": "Delay Near",
|
||||
"description": "Whether the train was delayed NEAR the 'delay_loation', else at the 'delay_location'",
|
||||
"type": "boolean"
|
||||
},
|
||||
"ip": {
|
||||
"title": "is_passenger",
|
||||
"description": "Whether this is a passenger service",
|
||||
"type": "boolean"
|
||||
},
|
||||
"ic": {
|
||||
"title": "is_charter",
|
||||
"description": "Whether this is a charter service",
|
||||
"type": "boolean"
|
||||
},
|
||||
"rs": {
|
||||
"title": "RSID",
|
||||
"description": "Retail Service ID",
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": ["h", "t", "ip", "ic"]
|
||||
},
|
||||
"locations": {
|
||||
"type": "array",
|
||||
"additionalItems": false,
|
||||
"items": {
|
||||
"$ref": "#/$defs/ServiceLocation"
|
||||
}
|
||||
},
|
||||
"pis": {
|
||||
"description": "PIS data for the service (if available)"
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -15,10 +15,10 @@ for file in $FILES; do
|
||||
clean_name=$(echo "${file#schemas/}" | sed 's/\//_/g' | sed 's/\.json//g')
|
||||
|
||||
# OGenerate TS
|
||||
npx --yes json-schema-to-typescript "$file" > "gen/ts/${clean_name}.ts"
|
||||
npx --yes json-schema-to-typescript "$file" > "./gen/ts/${clean_name}.ts"
|
||||
|
||||
# Generate Go
|
||||
go-jsonschema -p contracts "$file" > "gen/go/models/${clean_name}.go"
|
||||
go-jsonschema -p contracts "$file" > "./gen/go/models/${clean_name}.go"
|
||||
done
|
||||
|
||||
echo "✅ Generated single TS package in gen/ts"
|
||||
|
||||
Reference in New Issue
Block a user