Skip to content

Commit 92e68d0

Browse files
committed
incorporate meeting feedback 8 Dec 22
1 parent 1e0663c commit 92e68d0

1 file changed

Lines changed: 6 additions & 8 deletions

File tree

general-information.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -240,14 +240,10 @@ A Trip is defined by the following structure:
240240

241241
(?) Document that the route is obtained by hitting the /telemetry endpoint with a `trip_id`?
242242

243-
(?) Should we replace `Point` with `Telemetry`?
244-
245243
(?) Should we keep mix of `trip_` prefix vs. no prefix? E.g. `start_time`.
246244

247245
(?) Does anyone use `publication_time`?
248246

249-
(?) Should `fare` move into `trip_attributes`? No fare for delivery modes?
250-
251247
Examples of mode-specific `trip_attributes`:
252248

253249
| Field | Type | Required/Optional | Comments |
@@ -317,7 +313,7 @@ Events represent changes in vehicle status.
317313
| `event_types` | Enum[] | Required | Vehicle [event types][vehicle-events] for state change, with allowable values determined by `vehicle_state` |
318314
| `event_time` | [Timestamp][ts] | Required | Date/time that event occurred at. See [Event Times][event-times] |
319315
| `publication_time` | [Timestamp][ts] | Optional | Date/time that event became available through the status changes endpoint |
320-
| `event_location` | GeoJSON [Point Feature][point-geo] | Required | See also [Stop-based Geographic Data][stop-based-geo]. |
316+
| `event_location` | [Point][point-geo] | Required | See also [Stop-based Geographic Data][stop-based-geo]. |
321317
| `event_geographies` | UUID[] | Optional | **[Beta feature](/general-information.md#beta-features):** *Yes (as of 2.0.0)*. Array of Geography UUIDs consisting of every Geography that contains the location of the status change. See [Geography Driven Events][geography-driven-events]. Required if `event_location` is not present. |
322318
| `trip_ids`[] | UUID[] | Required if Applicable | Trip UUIDs (foreign key to /trips endpoint), required if `event_types` contains `trip_start`, `trip_end`, `trip_cancel`, `trip_enter_jurisdiction`, or `trip_leave_jurisdiction` |
323319
| `journey_id` | UUID | Optional | Journey UUID | TODO "see `journey_id`" or something |
@@ -359,6 +355,8 @@ A standard point of vehicle telemetry. References to latitude and longitude impl
359355
| `battery_percent` | Integer | Required if Applicable | Percent battery charge of vehicle, expressed between 0 and 100 |
360356
| `fuel_percent` | Integer | Required if Applicable | Percent fuel in vehicle, expressed between 0 and 100 |
361357

358+
(?) What about other types of sensor data, e.g. accelerometer? Scooter tip sensors? Should that be telemetry or an event or ... ?
359+
362360
[Top][toc]
363361

364362
## Stops
@@ -370,7 +368,7 @@ Stops describe vehicle trip start and end locations in a pre-designated physical
370368
| stop_id | UUID | Required | Unique ID for stop |
371369
| name | String | Required | Name of stop |
372370
| last_reported | Timestamp | Required | Date/Time that the stop was last updated |
373-
| location | GeoJSON [Point Feature](#stop-based-geographic-data) | Required | Simple centerpoint location of the Stop. The use of the optional `geography_id` is recommended to provide more detail. |
371+
| location | [Point](#stop-based-geographic-data) | Required | Simple centerpoint location of the Stop. The use of the optional `geography_id` is recommended to provide more detail. |
374372
| status | [Stop Status](#stop-status) | Required | Object representing the status of the Stop. See [Stop Status](#stop-status). |
375373
| capacity | {vehicle_type: number} | Required | Number of total places per vehicle_type |
376374
| num_vehicles_available | {vehicle_type: number} | Required | How many vehicles are available per vehicle_type at this stop? |
@@ -476,8 +474,8 @@ A vehicle record is as follows:
476474
| `last_event_time` | [Timestamp][ts] | Required | Date/time when last state change occurred. See [Event Times][event-times] |
477475
| `last_state` | Enum | Required | [Vehicle state][vehicle-states] of most recent state change. |
478476
| `last_event_types` | Enum[] | Required | [Vehicle event(s)][vehicle-events] of most recent state change, allowable values determined by `last_vehicle_state`. |
479-
| `last_event_location` | GeoJSON [Point Feature][point-geo]| Required | Location of vehicle's last event. See also [Stop-based Geographic Data][stop-based-geo]. |
480-
| `current_location` | GeoJSON [Point Feature][point-geo] | Required if Applicable | Current location of vehicle if different from last event, and the vehicle is not currently on a trip. See also [Stop-based Geographic Data][stop-based-geo]. |
477+
| `last_event_location` | [Point][point-geo]| Required | Location of vehicle's last event. See also [Stop-based Geographic Data][stop-based-geo]. |
478+
| `current_location` | [Point][point-geo] | Required if Applicable | Current location of vehicle if different from last event, and the vehicle is not currently on a trip. See also [Stop-based Geographic Data][stop-based-geo]. |
481479

482480
(?) Remove GeoJSON Point
483481

0 commit comments

Comments
 (0)