Skip to content

Commit 6d53528

Browse files
thekavemanthekaveman
committed
update agency schemas with new telemetry defs
1 parent cf9493d commit 6d53528

4 files changed

Lines changed: 98 additions & 50 deletions

File tree

‎agency/get_stops.json‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,30 @@
246246
},
247247
"stop_id": {
248248
"$ref": "#/definitions/uuid"
249+
},
250+
"altitude": {
251+
"type": "number",
252+
"description": "Altitude above mean sea level in meters"
253+
},
254+
"heading": {
255+
"type": "number",
256+
"description": "Degrees - clockwise starting at 0 degrees at true North"
257+
},
258+
"speed": {
259+
"type": "number",
260+
"description": "Estimated speed in meters / sec as reported by the GPS chipset"
261+
},
262+
"accuracy": {
263+
"type": "number",
264+
"description": "Horizontal accuracy, in meters"
265+
},
266+
"hdop": {
267+
"type": "number",
268+
"description": "Horizontal GPS or GNSS accuracy value"
269+
},
270+
"satellites": {
271+
"type": "integer",
272+
"description": "Number of GPS or GNSS satellites"
249273
}
250274
}
251275
},

‎agency/post_stops.json‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -246,6 +246,30 @@
246246
},
247247
"stop_id": {
248248
"$ref": "#/definitions/uuid"
249+
},
250+
"altitude": {
251+
"type": "number",
252+
"description": "Altitude above mean sea level in meters"
253+
},
254+
"heading": {
255+
"type": "number",
256+
"description": "Degrees - clockwise starting at 0 degrees at true North"
257+
},
258+
"speed": {
259+
"type": "number",
260+
"description": "Estimated speed in meters / sec as reported by the GPS chipset"
261+
},
262+
"accuracy": {
263+
"type": "number",
264+
"description": "Horizontal accuracy, in meters"
265+
},
266+
"hdop": {
267+
"type": "number",
268+
"description": "Horizontal GPS or GNSS accuracy value"
269+
},
270+
"satellites": {
271+
"type": "integer",
272+
"description": "Number of GPS or GNSS satellites"
249273
}
250274
}
251275
},

‎agency/post_vehicle_event.json‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,27 @@
44
"title": "The MDS Agency Schema, POST vehicle status body",
55
"type": "object",
66
"definitions": {
7-
"telemetry": {
8-
"$id": "#/definitions/telemetry",
7+
"timestamp": {
8+
"$id": "#/definitions/timestamp",
9+
"type": "number",
10+
"description": "Integer milliseconds since Unix epoch",
11+
"multipleOf": 1.0,
12+
"minimum": 1514764800000
13+
},
14+
"uuid": {
15+
"$id": "#/definitions/uuid",
16+
"type": "string",
17+
"description": "A UUID used to uniquely identifty an object",
18+
"default": "",
19+
"examples": [
20+
"3c9604d6-b5ee-11e8-96f8-529269fb1459"
21+
],
22+
"pattern": "^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"
23+
},
24+
"vehicle_telemetry": {
25+
"$id": "#/definitions/vehicle_telemetry",
926
"type": "object",
10-
"description": "A vehicle telemetry datum",
27+
"description": "A telemetry datum for a specific vehicle at a specific time",
1128
"required": [
1229
"device_id",
1330
"timestamp",
@@ -47,15 +64,15 @@
4764
},
4865
"heading": {
4966
"type": "number",
50-
"description": "Degrees clockwise from true north"
67+
"description": "Degrees - clockwise starting at 0 degrees at true North"
5168
},
5269
"speed": {
5370
"type": "number",
54-
"description": "Speed in meters/sec"
71+
"description": "Estimated speed in meters / sec as reported by the GPS chipset"
5572
},
5673
"accuracy": {
5774
"type": "number",
58-
"description": "Accuracy in meters"
75+
"description": "Horizontal accuracy, in meters"
5976
},
6077
"hdop": {
6178
"type": "number",
@@ -69,29 +86,12 @@
6986
},
7087
"charge": {
7188
"type": "number",
72-
"description": "Fraction of charge of the vehicle (required if applicable",
89+
"description": "Fraction of charge of the vehicle (required if applicable)",
7390
"minimum": 0,
7491
"maximum": 1
7592
}
7693
}
7794
},
78-
"timestamp": {
79-
"$id": "#/definitions/timestamp",
80-
"type": "number",
81-
"description": "Integer milliseconds since Unix epoch",
82-
"multipleOf": 1.0,
83-
"minimum": 1514764800000
84-
},
85-
"uuid": {
86-
"$id": "#/definitions/uuid",
87-
"type": "string",
88-
"description": "A UUID used to uniquely identifty an object",
89-
"default": "",
90-
"examples": [
91-
"3c9604d6-b5ee-11e8-96f8-529269fb1459"
92-
],
93-
"pattern": "^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"
94-
},
9595
"vehicle_state": {
9696
"$id": "#/definitions/vehicle_state",
9797
"type": "string",
@@ -167,7 +167,7 @@
167167
"$ref": "#/definitions/timestamp"
168168
},
169169
"telemetry": {
170-
"$ref": "#/definitions/telemetry"
170+
"$ref": "#/definitions/vehicle_telemetry"
171171
},
172172
"trip_id": {
173173
"$ref": "#/definitions/uuid"

‎agency/post_vehicle_telemetry.json‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,27 @@
44
"title": "The MDS Agency Schema, POST vehicle telemetry body",
55
"type": "object",
66
"definitions": {
7-
"telemetry": {
8-
"$id": "#/definitions/telemetry",
7+
"timestamp": {
8+
"$id": "#/definitions/timestamp",
9+
"type": "number",
10+
"description": "Integer milliseconds since Unix epoch",
11+
"multipleOf": 1.0,
12+
"minimum": 1514764800000
13+
},
14+
"uuid": {
15+
"$id": "#/definitions/uuid",
16+
"type": "string",
17+
"description": "A UUID used to uniquely identifty an object",
18+
"default": "",
19+
"examples": [
20+
"3c9604d6-b5ee-11e8-96f8-529269fb1459"
21+
],
22+
"pattern": "^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"
23+
},
24+
"vehicle_telemetry": {
25+
"$id": "#/definitions/vehicle_telemetry",
926
"type": "object",
10-
"description": "A vehicle telemetry datum",
27+
"description": "A telemetry datum for a specific vehicle at a specific time",
1128
"required": [
1229
"device_id",
1330
"timestamp",
@@ -47,15 +64,15 @@
4764
},
4865
"heading": {
4966
"type": "number",
50-
"description": "Degrees clockwise from true north"
67+
"description": "Degrees - clockwise starting at 0 degrees at true North"
5168
},
5269
"speed": {
5370
"type": "number",
54-
"description": "Speed in meters/sec"
71+
"description": "Estimated speed in meters / sec as reported by the GPS chipset"
5572
},
5673
"accuracy": {
5774
"type": "number",
58-
"description": "Accuracy in meters"
75+
"description": "Horizontal accuracy, in meters"
5976
},
6077
"hdop": {
6178
"type": "number",
@@ -69,28 +86,11 @@
6986
},
7087
"charge": {
7188
"type": "number",
72-
"description": "Fraction of charge of the vehicle (required if applicable",
89+
"description": "Fraction of charge of the vehicle (required if applicable)",
7390
"minimum": 0,
7491
"maximum": 1
7592
}
7693
}
77-
},
78-
"timestamp": {
79-
"$id": "#/definitions/timestamp",
80-
"type": "number",
81-
"description": "Integer milliseconds since Unix epoch",
82-
"multipleOf": 1.0,
83-
"minimum": 1514764800000
84-
},
85-
"uuid": {
86-
"$id": "#/definitions/uuid",
87-
"type": "string",
88-
"description": "A UUID used to uniquely identifty an object",
89-
"default": "",
90-
"examples": [
91-
"3c9604d6-b5ee-11e8-96f8-529269fb1459"
92-
],
93-
"pattern": "^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})$"
9494
}
9595
},
9696
"required": [
@@ -100,7 +100,7 @@
100100
"data": {
101101
"type": "array",
102102
"items": {
103-
"$ref": "#/definitions/telemetry"
103+
"$ref": "#/definitions/vehicle_telemetry"
104104
}
105105
}
106106
},

0 commit comments

Comments
 (0)