Skip to content

Commit c158546

Browse files
committed
Fixes to trip_*_jurisdiction names
1 parent 7319e24 commit c158546

3 files changed

Lines changed: 30 additions & 30 deletions

File tree

modes/car-share.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -72,9 +72,9 @@ The `journey_attributes` array **may** have the following key value pairs:
7272

7373
### Trip ID Requirements
7474

75-
Events require a valid `trip_id` in events where `event_types` contains `reservation_start`, `reservation_stop`, `trip_start`, `trip_stop`, `trip_end`, `passenger_cancellation`, `provider_cancellation`.
75+
Events require a valid `trip_id` in events where `event_types` contains `reservation_start`, `reservation_stop`, `trip_start`, `trip_pause`, `trip_resume`, `trip_end`,`trip_cancel`, `customer_cancellation`, `provider_cancellation`, or `driver_cancellation`.
7676

77-
Additionally, `trip_id` is required if `event_types` contains a `enter_jurisdiction` or `leave_jurisdiction` event pertaining to a trip.
77+
Additionally, `trip_id` is required if `event_types` contains a `trip_enter_jurisdiction` or `trip_leave_jurisdiction` event pertaining to a trip.
7878

7979
[Top][toc]
8080

@@ -224,15 +224,15 @@ This is the list of `vehicle_state` and `event_type` pairings that constitute th
224224

225225
| **From** `vehicle_state` | **To** `vehicle_state` | `trip_state` | `event_type` | Description |
226226
| ------------------------ | ---------------------- | ------------ | ------------------------ | --------------------------------------------------------------------------------------------------------------- |
227-
| `available` | `elsewhere` | N/A | `leave_jurisdiction` | The vehicle has left jurisdictional boundaries while available for-hire |
227+
| `available` | `elsewhere` | N/A | `trip_leave_jurisdiction` | The vehicle has left jurisdictional boundaries while available for-hire |
228228
| `available` | `non_contactable` | N/A | `comms_lost` | The vehicle has went out of comms while available for-use |
229229
| `available` | `non_operational` | N/A | `service_end` | The vehicle has went out of service (is unavailable for-hire) |
230230
| `available` | `reserved` | `reserved` | `reserve` | The vehicle was reserved by a passenger |
231-
| `elsewhere` | `available` | N/A | `enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while available for-hire |
231+
| `elsewhere` | `available` | N/A | `trip_enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while available for-hire |
232232
| `elsewhere` | `non_contactable` | N/A | `comms_lost` | The vehicle has went out of comms while outside of jurisdictional boundaries |
233-
| `elsewhere` | `non_operational` | N/A | `enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while not operating commercially |
234-
| `elsewhere` | `on_trip` | `on_trip` | `enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while on a trip |
235-
| `elsewhere` | `reserved` | N/A | `enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while reserved by a customer |
233+
| `elsewhere` | `non_operational` | N/A | `trip_enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while not operating commercially |
234+
| `elsewhere` | `on_trip` | `on_trip` | `trip_enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while on a trip |
235+
| `elsewhere` | `reserved` | N/A | `trip_enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while reserved by a customer |
236236
| `non_contactable` | `available` | N/A | `comms_restored` | The vehicle has come back into comms while available for-hire |
237237
| `non_contactable` | `elsewhere` | N/A | `comms_restored` | The vehicle has come back into comms while outside of jurisdictional boundaries |
238238
| `non_contactable` | `non_operational` | N/A | `comms_restored` | The vehicle has come back into comms while not operating commercially |
@@ -241,12 +241,12 @@ This is the list of `vehicle_state` and `event_type` pairings that constitute th
241241
| `non_contactable` | `reserved` | `reserved` | `comms_restored` | The vehicle has come back into comms while reserved by a passenger |
242242
| `non_contactable` | `stopped` | `stopped` | `comms_restored` | The vehicle has come back into comms while stopped |
243243
| `non_operational` | `available` | N/A | `service_start` | The vehicle has went into service (is available for-hire) |
244-
| `non_operational` | `elsewhere` | N/A | `leave_jurisdiction` | The vehicle has left jurisdictional boundaries while not operating commercially |
244+
| `non_operational` | `elsewhere` | N/A | `trip_leave_jurisdiction` | The vehicle has left jurisdictional boundaries while not operating commercially |
245245
| `non_operational` | `non_contactable` | N/A | `comms_lost` | The vehicle has went out of comms while not operating commercially |
246246
| `non_operational` | `removed` | N/A | `decommissioned` | The vehicle has been removed from the Provider's fleet |
247247
| `non_operational` | `removed` | N/A | `maintenance_pick_up` | The vehicle has entered the depot for maintenance |
248248
| `non_operational` | `removed` | N/A | `maintenance` | The vehicle is undergoing maintenance on site |
249-
| `on_trip` | `elsewhere` | N/A | `leave_jurisdiction` | The vehicle has left jurisdictional boundaries while on a trip |
249+
| `on_trip` | `elsewhere` | N/A | `trip_leave_jurisdiction` | The vehicle has left jurisdictional boundaries while on a trip |
250250
| `on_trip` | `non_contactable` | N/A | `comms_lost` | The vehicle has gone out of comms while on a trip |
251251
| `on_trip` | `stopped` | `stopped` | `trip_stop` | The vehicle has stopped while on a trip |
252252
| `removed` | `non_contactable` | N/A | `comms_lost` | The vehicle has gone out of comms while removed |
@@ -255,7 +255,7 @@ This is the list of `vehicle_state` and `event_type` pairings that constitute th
255255
| `reserved` | `available` | N/A | `driver_cancellation` | The driver has canceled the reservation |
256256
| `reserved` | `available` | N/A | `passenger_cancellation` | The passenger has canceled the reservation |
257257
| `reserved` | `available` | N/A | `provider_cancellation` | The provider has canceled the reservation |
258-
| `reserved` | `elsewhere` | N/A | `leave_jurisdiction` | The vehicle has left the jurisdiction while in a reservation |
258+
| `reserved` | `elsewhere` | N/A | `trip_leave_jurisdiction` | The vehicle has left the jurisdiction while in a reservation |
259259
| `reserved` | `non_contactable` | N/A | `comms_lost` | The vehicle went out of comms while being reserved by a passenger |
260260
| `reserved` | `stopped` | `stopped` | `reserve_stop` | The vehicle has stopped to pick up the passenger |
261261
| `stopped` | `available` | N/A | `driver_cancellation` | The driver has canceled the trip while either waiting for the passenger, or dropping them off |

modes/delivery-robots.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -72,11 +72,11 @@ The `journey_attributes` array is not used in this mode.
7272

7373
### Trip ID Requirements
7474

75-
Events require a valid `trip_id` in events where `event_types` contains `reservation_start`, `reservation_stop`, `trip_start`, `trip_pause`, `trip_end`, `customer_cancellation`, `provider_cancellation`, or `driver_cancellation`.
75+
Events require a valid `trip_id` in events where `event_types` contains `reservation_start`, `reservation_stop`, `trip_start`, `trip_pause`, `trip_resume`, `trip_end`,`trip_cancel`, `customer_cancellation`, `provider_cancellation`, or `driver_cancellation`.
7676

7777
For the robots, the notion of driver does not exist, even when remotely operated.
7878

79-
Additionally, `trip_id` is required if `event_types` contains a `enter_jurisdiction` or `leave_jurisdiction` event pertaining to a delivery trip.
79+
Additionally, `trip_id` is required if `event_types` contains a `trip_enter_jurisdiction` or `trip_leave_jurisdiction` event pertaining to a trip.
8080

8181
### Trip Type
8282

@@ -221,15 +221,15 @@ This is the list of `vehicle_state` and `event_type` pairings that constitute th
221221

222222
| **From** `vehicle_state` | **To** `vehicle_state` | `trip_state` | `event_type` | Description |
223223
| ------------------------ | ---------------------- | ------------ | ----------------------- | --------------------------------------------------------------------------------------------- |
224-
| `available` | `elsewhere` | N/A | `leave_jurisdiction` | The vehicle has left jurisdictional boundaries while available for-hire |
224+
| `available` | `elsewhere` | N/A | `trip_leave_jurisdiction` | The vehicle has left jurisdictional boundaries while available for-hire |
225225
| `available` | `non_contactable` | N/A | `comms_lost` | The vehicle has gone out of comms while available for-use |
226226
| `available` | `non_operational` | N/A | `service_end` | The vehicle has gone out of service (is unavailable for-hire) |
227227
| `available` | `reserved` | `reserved` | `reserve` | The vehicle was reserved by a customer |
228-
| `elsewhere` | `available` | N/A | `enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while available for-hire |
228+
| `elsewhere` | `available` | N/A | `trip_enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while available for-hire |
229229
| `elsewhere` | `non_contactable` | N/A | `comms_lost` | The vehicle has gone out of comms while outside of jurisdictional boundaries |
230-
| `elsewhere` | `non_operational` | N/A | `enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while not operating commercially |
231-
| `elsewhere` | `on_trip` | `on_trip` | `enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while on a trip |
232-
| `elsewhere` | `reserved` | N/A | `enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while reserved by a customer |
230+
| `elsewhere` | `non_operational` | N/A | `trip_enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while not operating commercially |
231+
| `elsewhere` | `on_trip` | `on_trip` | `trip_enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while on a trip |
232+
| `elsewhere` | `reserved` | N/A | `trip_enter_jurisdiction` | The vehicle has entered jurisdictional boundaries while reserved by a customer |
233233
| `missing` | `available` | N/A | `located` | The vehicle has been located while available for-hire |
234234
| `missing` | `elsewhere` | N/A | `located` | The vehicle has been located while outside of jurisdictional boundaries |
235235
| `missing` | `non_operational` | N/A | `located` | The vehicle has been located while not operating commercially |
@@ -246,12 +246,12 @@ This is the list of `vehicle_state` and `event_type` pairings that constitute th
246246
| `non_contactable` | `reserved` | `reserved` | `comms_restored` | The vehicle has come back into comms while reserved by a customer |
247247
| `non_contactable` | `stopped` | `stopped` | `comms_restored` | The vehicle has come back into comms while stopped |
248248
| `non_operational` | `available` | N/A | `service_start` | The vehicle has gone into service (is available for-hire) |
249-
| `non_operational` | `elsewhere` | N/A | `leave_jurisdiction` | The vehicle has left jurisdictional boundaries while not operating commercially |
249+
| `non_operational` | `elsewhere` | N/A | `trip_leave_jurisdiction` | The vehicle has left jurisdictional boundaries while not operating commercially |
250250
| `non_operational` | `non_contactable` | N/A | `comms_lost` | The vehicle has gone out of comms while not operating commercially |
251251
| `non_operational` | `removed` | N/A | `decommissioned` | The vehicle has been removed from the Provider's fleet |
252252
| `non_operational` | `removed` | N/A | `maintenance_start` | The vehicle has entered the depot for maintenance |
253253
| `on_trip` | `available` | N/A | `order_drop_off` | The vehicle is at the customer's place and is waiting for them |
254-
| `on_trip` | `elsewhere` | N/A | `leave_jurisdiction` | The vehicle has left jurisdictional boundaries while on a trip |
254+
| `on_trip` | `elsewhere` | N/A | `trip_leave_jurisdiction` | The vehicle has left jurisdictional boundaries while on a trip |
255255
| `on_trip` | `non_contactable` | N/A | `comms_lost` | The vehicle has gone out of comms while on a trip to pick up the order |
256256
| `on_trip` | `stopped` | N/A | `order_drop_off` | The vehicle is at the customer's place and is waiting for them |
257257
| `on_trip` | `stopped` | `stopped` | `order_pick_up` | The vehicle has come to pick up the order at the restaurant |
@@ -262,7 +262,7 @@ This is the list of `vehicle_state` and `event_type` pairings that constitute th
262262
| `reserved` | `available` | N/A | `customer_cancellation` | The customer has canceled the reservation |
263263
| `reserved` | `available` | N/A | `driver_cancellation` | The driver has canceled the reservation |
264264
| `reserved` | `available` | N/A | `provider_cancellation` | The provider has canceled the reservation |
265-
| `reserved` | `elsewhere` | N/A | `leave_jurisdiction` | The vehicle has left the jurisdiction while in a reservation |
265+
| `reserved` | `elsewhere` | N/A | `trip_leave_jurisdiction` | The vehicle has left the jurisdiction while in a reservation |
266266
| `reserved` | `non_contactable` | N/A | `comms_lost` | The vehicle has gone of comms while being reserved by a customer |
267267
| `reserved` | `stopped` | `stopped` | `reserve_stop` | The vehicle has stopped to pickup reservation |
268268
| `stopped` | `available` | N/A | `customer_cancellation` | The customer has canceled the trip while the vehicle is waiting |

0 commit comments

Comments
 (0)