Skip to content

Commit 0add737

Browse files
committed
nits
1 parent 3f1f9b2 commit 0add737

2 files changed

Lines changed: 4 additions & 6 deletions

File tree

data-types.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
A vehicle record is as follows:
2121

2222
| Field | Type | Required/Optional | Comments |
23-
| -------------------- | -------- | --------------------- | ----- |
23+
| -------------------- | -------- | --------------------- | -------- |
2424
| `provider_id` | UUID | Required | A UUID for the Provider, unique within MDS. See MDS [provider list](/providers.csv). |
2525
| `device_id` | UUID | Required | A unique device ID in UUID format, should match this device in Provider |
2626
| `vehicle_id` | String | Required | A unique vehicle identifier (visible code, licence plate, etc), visible on the vehicle itself |
@@ -87,7 +87,7 @@ A vehicle status record represents the current or last-known disposition of a ve
8787
Events represent changes in vehicle status.
8888

8989
| Field | Type | Required/Optional | Comments |
90-
| ----- | ---- | ----------------- | ----- |
90+
| ----- | ---- | ----------------- | -------- |
9191
| `provider_id` | UUID | Required | A UUID for the Provider, unique within MDS. See MDS [provider list](/providers.csv). |
9292
| `provider_name` | String | Required | The public-facing name of the Provider |
9393
| `device_id` | UUID | Required | A unique device ID in UUID format |
@@ -104,7 +104,7 @@ Events represent changes in vehicle status.
104104

105105
(?) Do we still want `event_geographies`?
106106

107-
(?) Replace `event_location` GeoJSON with Telemetry
107+
(?) Replace `event_location` GeoJSON with GPS?
108108

109109
(?) Does anyone use `associated_ticket`?
110110

@@ -132,8 +132,6 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
132132
| `battery_percent` | Integer | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 100 |
133133
| `fuel_percent` | Integer | Required if Applicable | Percent fuel in vehicle, expressed between 0 and 100 |
134134

135-
(?) What about other types of sensor data, e.g. accelerometer? Scooter tip sensors? Should that be telemetry or an event or ... ?
136-
137135
### GPS Data
138136

139137
| Field | Type | Required/Optional | Field Description |

provider/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ Trips that start or end at a [Stop][stops] must include a `stop_id` property in
249249

250250
The `/events/recent` and `/events/historical/` endpoints return a list of Event objects, describing the activity of the Provider's vehicles. Recent events are at most two weeks old and can be queried with start/stop time, and historical events are packaged in hour-sized chunks for ease of implementation.
251251

252-
(?) This distinction is a holdover from MDS 1.x. Dramatic simplification of the query is meant to make cold storage by hourly chunks trivial without a database. We should ask Providers if that has been a concern in practice.
252+
(?) This distinction is a holdover from MDS 1.x. Dramatic simplification of the query is meant to make cold storage by hourly chunks trivial without a database. We should ask Providers if that has been a concern in practice. Alternatively they could be the same endpoint with different parameters.
253253

254254
Unless stated otherwise by the municipality, this endpoint must return only those status changes with a `event_location` that [intersects](#intersection-operation) with the [municipality boundary](#municipality-boundary).
255255

0 commit comments

Comments
 (0)