Skip to content

Commit feed48e

Browse files
authored
Added optional field info links - delivery robots
Signed-off-by: Michael Schnuerle <1285077+schnuerle@users.noreply.github.com>
1 parent dcc4fe2 commit feed48e

1 file changed

Lines changed: 25 additions & 25 deletions

File tree

modes/delivery-robots.md

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -87,21 +87,21 @@ The `trip_type` field **must** have one of the following enumerated values:
8787
The `trip_attributes` object **may** have the following key value pairs:
8888

8989
- `driver_type` (enum, required): type of driver operating the device: `human`, `semi_autonomous`, `autonomous`
90-
- `driver_id` (UUID, optional): consistent unique identifier of the primary driver. Could be based on software version or an internal human driver id.
91-
- `app_name` (text, optional): name of the app used to reserve the trip which could be provider's app or 3rd party app
92-
- `requested_time` ([Timestamp][ts], optional): when the customer requested the trip
93-
- `has_payload` (boolean, optional): is there any payload for any delivery included in the device at trip start. 1 = loaded, 0 = empty
94-
- `range` (integer, optional): estimated range in meters based on energy levels in device at trip start
95-
- `identification_required` (boolean, optional): does the cargo require providing customer identification before trip start or upon delivery?
90+
- `driver_id` (UUID, [Optional](./general-information.md#optional-fields]): consistent unique identifier of the primary driver. Could be based on software version or an internal human driver id.
91+
- `app_name` (text, [Optional](./general-information.md#optional-fields]): name of the app used to reserve the trip which could be provider's app or 3rd party app
92+
- `requested_time` ([Timestamp][ts], [Optional](./general-information.md#optional-fields]): when the customer requested the trip
93+
- `has_payload` (boolean, [Optional](./general-information.md#optional-fields]): is there any payload for any delivery included in the device at trip start. 1 = loaded, 0 = empty
94+
- `range` (integer, [Optional](./general-information.md#optional-fields]): estimated range in meters based on energy levels in device at trip start
95+
- `identification_required` (boolean, [Optional](./general-information.md#optional-fields]): does the cargo require providing customer identification before trip start or upon delivery?
9696

9797
[Top][toc]
9898

9999
### Fare Attributes
100100

101101
The `fare_attributes` object **may** have the following key value pairs:
102102

103-
- `payment_type` (enumerated, optional): `account_number`, `cash`, `credit_card`, `mobile_app`, `no payment`, `phone`, `voucher`, `test`
104-
- `price` (currency, optional): Total price of the order
103+
- `payment_type` (enumerated, [Optional](./general-information.md#optional-fields]): `account_number`, `cash`, `credit_card`, `mobile_app`, `no payment`, `phone`, `voucher`, `test`
104+
- `price` (currency, [Optional](./general-information.md#optional-fields]): Total price of the order
105105

106106
[Top][toc]
107107

@@ -113,30 +113,30 @@ _See more available vehicle attributes and accessibility attributes for any mode
113113

114114
The `vehicle_attributes` object **may** have the following key value pairs:
115115

116-
- `year` (integer, optional)
117-
- `make` (string, optional)
118-
- `model` (string, optional)
119-
- `color` (string, optional)
120-
- `inspection_date` (date YYYY-MM-DD, optional): the date of the last inspection of the vehicle
121-
- `equipped_cameras` (integer, optional): number of cameras equipped on device
122-
- `equipped_lighting` (integer, optional): number of lights used to illuminate the environment on the the device
123-
- `wheel_count` (integer, optional): number of wheels on the device
124-
- `width` (integer, optional): width in meters of the device
125-
- `length` (integer, optional): length in meters of the device
126-
- `height` (integer, optional): height in meters of the device (minus flexible elements like flags)
127-
- `weight` (integer, optional): weight in kilograms rounded up of the device not including cargo
128-
- `top_speed` (integer, optional): theoretical top speed in meters per second of the device
129-
- `storage_capacity` (integer, optional): cubic centimeters of cargo space available not including any cargo
116+
- `year` (integer, [Optional](./general-information.md#optional-fields])
117+
- `make` (string, [Optional](./general-information.md#optional-fields])
118+
- `model` (string, [Optional](./general-information.md#optional-fields])
119+
- `color` (string, [Optional](./general-information.md#optional-fields])
120+
- `inspection_date` (date YYYY-MM-DD, [Optional](./general-information.md#optional-fields]): the date of the last inspection of the vehicle
121+
- `equipped_cameras` (integer, [Optional](./general-information.md#optional-fields]): number of cameras equipped on device
122+
- `equipped_lighting` (integer, [Optional](./general-information.md#optional-fields]): number of lights used to illuminate the environment on the the device
123+
- `wheel_count` (integer, [Optional](./general-information.md#optional-fields]): number of wheels on the device
124+
- `width` (integer, [Optional](./general-information.md#optional-fields]): width in meters of the device
125+
- `length` (integer, [Optional](./general-information.md#optional-fields]): length in meters of the device
126+
- `height` (integer, [Optional](./general-information.md#optional-fields]): height in meters of the device (minus flexible elements like flags)
127+
- `weight` (integer, [Optional](./general-information.md#optional-fields]): weight in kilograms rounded up of the device not including cargo
128+
- `top_speed` (integer, [Optional](./general-information.md#optional-fields]): theoretical top speed in meters per second of the device
129+
- `storage_capacity` (integer, [Optional](./general-information.md#optional-fields]): cubic centimeters of cargo space available not including any cargo
130130

131131
[Top][toc]
132132

133133
### Accessibility Attributes
134134

135135
The `accessibility_attributes` object **may** have the following key value pairs:
136136

137-
- `audio_cue` (boolean, optional): is the device equipped with audio cues upon delivery
138-
- `visual_cue` (boolean, optional): is the device equipped with visual cues upon delivery
139-
- `remote_open` (boolean, optional): can the device door be remotely opened to retrieve cargo upon delivery
137+
- `audio_cue` (boolean, [Optional](./general-information.md#optional-fields]): is the device equipped with audio cues upon delivery
138+
- `visual_cue` (boolean, [Optional](./general-information.md#optional-fields]): is the device equipped with visual cues upon delivery
139+
- `remote_open` (boolean, [Optional](./general-information.md#optional-fields]): can the device door be remotely opened to retrieve cargo upon delivery
140140

141141
[Top][toc]
142142

0 commit comments

Comments
 (0)