Skip to content

Commit 5f4bb0d

Browse files
committed
Improved modes cross linking
1 parent f362cb3 commit 5f4bb0d

4 files changed

Lines changed: 25 additions & 33 deletions

File tree

modes/car-share.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ The short name identifier for Car Share used across MDS is `car-share`.
3636

3737
## Trip Properties
3838

39+
_See more available trip and fare attributes for any mode used in the [trips object](/data-types.md#trips)._
40+
3941
### Journey ID
4042

4143
The `journey_id` field shall have a consistent value in overlapping trips for a single reservation period, e.g. trips taken by a customer between ignition states over the duration of their reservation. A reservation is the duration the customer has continuous exclusive access to the vehicle whether parked or in motion. Journeys may be point-to-point or multi-segment.
@@ -92,11 +94,9 @@ The `trip_attributes` array **may** have the following key value pairs:
9294

9395
- `hail_type` (enumerated, required): `phone_dispatch`, `phone`, `text`, `app`
9496
- `app_name` (text, optional): name of the app used to reserve the trip which could be provider's app or 3rd party app
95-
- `permit_licence_number` (string, optional) - The permit licence number of the organization that dispatched the vehicle
97+
- `permit_license_number` (string, optional) - The permit license number of the organization that dispatched the vehicle
9698
- `driver_id` (string, optional): Universal identifier of a specific driver, static across operators, like a driver's license number, for company employees in `reservation` or `empty` trip types, not `private` trips. Could also be used as a lookup in an agency's internal driver system.
9799

98-
_See more available trip attributes for any mode in the [trips endpoint](/provider#trips)._
99-
100100
[Top][toc]
101101

102102
### Fare Attributes
@@ -114,12 +114,12 @@ The `fare_attributes` array **may** have the following key value pairs:
114114
- `taxes` (currency, optional) - amount of taxes paid for the ride
115115
- `surcharge` (currency, optional) - any surcharge pricing
116116

117-
_See more available fare attributes for any mode in the [trips endpoint](/provider#trips)._
118-
119117
[Top][toc]
120118

121119
## Vehicle Properties
122120

121+
_See more available vehicle attributes and accessibility options for any mode used in the [vehicles object](/data-types.md#vehicles)._
122+
123123
### Vehicle Attributes
124124

125125
The `vehicle_attributes` array **may** have the following key value pairs:
@@ -137,9 +137,7 @@ The `vehicle_attributes` array **may** have the following key value pairs:
137137
- `park_access` (boolean, optional) - access pass to a national/regional/municipal park system
138138
- `toll_transponder` (boolean, optional) - toll transponder for national/regional toll system
139139
- `phone_charger` (boolean, optional) - a place to charge your phone
140-
- `sunshade` (boolean, optional) - sunshade avaialable (i.e. for windshield)
141-
142-
_See more available vehicle attributes for any mode in the [vehicles endpoint](/provider#vehicles)._
140+
- `sunshade` (boolean, optional) - sunshade available (i.e. for windshield)
143141

144142
[Top][toc]
145143

modes/delivery-robots.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# Mobility Data Specification: **Delivery Robots**
22

3-
<img src="https://i.imgur.com/f8iMepu.png" width="120" align="right" alt="MDS Modes - Delivey Robots" border="0">
3+
<img src="https://i.imgur.com/f8iMepu.png" width="120" align="right" alt="MDS Modes - Delivery Robots" border="0">
44

5-
**Delivey Robots** refers to autonomous and remotely driven goods delivery devices. There can be one or multiple orders on different trips at the same time. The state machine tracks the trip states of the orders separately from the vehicle state.
5+
**Delivery Robots** refers to autonomous and remotely driven goods delivery devices. There can be one or multiple orders on different trips at the same time. The state machine tracks the trip states of the orders separately from the vehicle state.
66

77
See the [modes overview](/modes) for how the mode specific information below applies across MDS.
88

99
## Robots Vs Other Delivery Types
1010

11-
Autonomous and remotely piloted delivery robots do not require a driver, whereas other forms of deliveries may, e.g. in a commerical or private car, truck, bike, etc. For this MDS release, this mode is limited to deliveries where a human driver is not on board the vehicle doing the delivery, and human passengers are not being transported.
11+
Autonomous and remotely piloted delivery robots do not require a driver, whereas other forms of deliveries may, e.g. in a commercial or private car, truck, bike, etc. For this MDS release, this mode is limited to deliveries where a human driver is not on board the vehicle doing the delivery, and human passengers are not being transported.
1212

1313
## Table of Contents
1414

@@ -40,6 +40,8 @@ The short name identifier for deliveries used across MDS is `delivery-robots`.
4040

4141
## Trip Properties
4242

43+
_See more available trip and fare attributes for any mode used in the [trips object](/data-types.md#trips)._
44+
4345
### Journey ID
4446

4547
The `journey_id` field shall have a consistent value in overlapping trips. Journeys may be point-to-point, multi-segment, or multi-segment overlapping.
@@ -94,16 +96,14 @@ The `trip_type` field **must** have one of the following enumerated values:
9496

9597
The `trip_attributes` array **may** have the following key value pairs:
9698

97-
- `driver_type` (ennum, required): type of driver operating the device: `human`, `semi-autonomous`, `autonomous`
98-
- `driver_id` (UUID, optional): consistent unique identifier of the privary driver. Could be based on software version or an internal human driver id.
99+
- `driver_type` (enum, required): type of driver operating the device: `human`, `semi-autonomous`, `autonomous`
100+
- `driver_id` (UUID, optional): consistent unique identifier of the primary driver. Could be based on software version or an internal human driver id.
99101
- `app_name` (text, optional): name of the app used to reserve the trip which could be provider's app or 3rd party app
100102
- `request_time` (timestamp, optional): when the customer requested the trip
101103
- `has_payload` (boolean, optional): is there any payload for any delivery included in the device at trip start. 1 = loaded, 0 = empty
102-
- `range` (interger, optional): estimated range in meters based on energy levels in device at trip start
104+
- `range` (integer, optional): estimated range in meters based on energy levels in device at trip start
103105
- `identification_required` (boolean, optional): does the cargo require providing customer identification before trip start or upon delivery?
104106

105-
_See more available trip attributes for any mode in the [trips endpoint](/provider#trips)._
106-
107107
[Top][toc]
108108

109109
### Fare Attributes
@@ -113,12 +113,12 @@ The `fare_attributes` array **may** have the following key value pairs:
113113
- `payment_type` (enumerated, optional): `cash`, `mobile`, `voucher`, `paratransit`, `no payment`, `test`
114114
- `price` (currency, optional): Total price of the order
115115

116-
_See more available fare attributes for any mode in the [trips endpoint](/provider#trips)._
117-
118116
[Top][toc]
119117

120118
## Vehicle Properties
121119

120+
_See more available vehicle attributes and accessibility options for any mode used in the [vehicles object](/data-types.md#vehicles)._
121+
122122
### Vehicle Attributes
123123

124124
The `vehicle_attributes` array **may** have the following key value pairs:
@@ -138,8 +138,6 @@ The `vehicle_attributes` array **may** have the following key value pairs:
138138
- `top_speed` (integer, optional): theoretical top speed in meters per second of the device
139139
- `storage_capacity` (integer, optional): cubic centimeters of cargo space available not including any cargo
140140

141-
_See more available vehicle attributes for any mode in the [vehicles endpoint](/provider#vehicles)._
142-
143141
[Top][toc]
144142

145143
### Accessibility Options
@@ -289,7 +287,7 @@ When there is only one trip ongoing, `trip_state == vehicle_state`
289287

290288
In cases where there are multiple trips ongoing, please follow the trip state model pseudocode for determining what the vehicle state should be:
291289
```
292-
t = for the one vehicle, all on-going trips which are 'delivey' or undefined trips (we do not take into account 'roaming', 'return' or 'advertising' trips)
290+
t = for the one vehicle, all on-going trips which are 'delivery' or undefined trips (we do not take into account 'roaming', 'return' or 'advertising' trips)
293291
v = vehicle state
294292
if t.any(state == ‘stopped’):
295293
v = ‘stopped’

modes/micromobility.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ The short name identifier for Micromobility used across MDS is `micromobility`.
3636

3737
## Trip Properties
3838

39+
_See more available trip and fare attributes for any mode used in the [trips object](/data-types.md#trips)._
40+
3941
### Journey ID
4042

4143
The `journey_id` field is not used in this mode. Trips are point-to-point.
@@ -68,30 +70,26 @@ The `trip_type` field **may** have one of the following values:
6870

6971
The `trip_attributes` array is not used in this mode.
7072

71-
_See more available trip attributes for any mode in the [trips endpoint](/provider#trips)._
72-
7373
[Top][toc]
7474

7575
### Fare Attributes
7676

7777
The `fare_attributes` array is not used in this mode.
7878

79-
_See more available fare attributes for any mode in the [trips endpoint](/provider#trips)._
80-
8179
[Top][toc]
8280

8381
## Vehicle Properties
8482

8583
### Vehicle Attributes
8684

85+
_See more available vehicle attributes and accessibility options for any mode used in the [vehicles object](/data-types.md#vehicles)._
86+
8787
The `vehicle_attributes` array **may** have the following key value pairs:
8888

8989
- `year` (integer, optional)
9090
- `make` (string, optional)
9191
- `model` (string, optional)
9292

93-
_See more available vehicle attributes for any mode in the [vehicles endpoint](/provider#vehicles)._
94-
9593
[Top][toc]
9694

9795
### Accessibility Options

modes/passenger-services.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ The short name identifier for Passenger Services used across MDS is `passenger-s
4040

4141
## Trip Properties
4242

43+
_See more available trip and fare attributes for any mode used in the [trips object](/data-types.md#trips)._
44+
4345
### Journey ID
4446

4547
The `journey_id` field shall have a consistent value in overlapping trips, e.g. "pooled" or "shared" rides with different start and/or end locations. Journeys may be point-to-point, multi-segment, or multi-segment overlapping.
@@ -107,8 +109,6 @@ The `trip_attributes` array **may** have the following key value pairs:
107109
- `wheelchair_transported` (boolean, optional) - was a wheelchair transported as part of this trip?
108110
- `cancellation_reason` (String, Conditionally Required): The reason why a *driver* cancelled a reservation. (required if a driver cancelled a trip, and a `driver_cancellation` event_type was part of the trip)
109111

110-
_See more available trip attributes for any mode in the [trips endpoint](/provider#trips)._
111-
112112
[Top][toc]
113113

114114
### Fare Attributes
@@ -130,12 +130,12 @@ The `fare_attributes` array **may** have the following key value pairs:
130130
- `driver_trip_pay` (currency, optional) - The payment the driver received for the trip
131131
- `rate_code_id` (enumerated, optional) - one of `meter_fare`, `shared`, `out_of_town`, `disabled`, `upfront_pricing`, `promo_rate`
132132

133-
_See more available fare attributes for any mode in the [trips endpoint](/provider#trips)._
134-
135133
[Top][toc]
136134

137135
## Vehicle Properties
138136

137+
_See more available vehicle attributes and accessibility options for any mode used in the [vehicles object](/data-types.md#vehicles)._
138+
139139
### Vehicle Attributes
140140

141141
The `vehicle_attributes` array **may** have the following key value pairs:
@@ -149,8 +149,6 @@ The `vehicle_attributes` array **may** have the following key value pairs:
149149
- `license_plate` (string, optional) - the registered vehicle license/number/registration plate identifier on the vehicle
150150
- `inspection_date` (date YYYY-MM-DD, optional) - the date of the last inspection of the vehicle
151151

152-
_See more available vehicle attributes for any mode in the [vehicles endpoint](/provider#vehicles)._
153-
154152
[Top][toc]
155153

156154
### Accessibility Options

0 commit comments

Comments
 (0)