Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add description to vehicle_types #470

Merged
merged 3 commits into from
Jan 23, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions gbfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -522,6 +522,9 @@ Field Name | REQUIRED | Type | Defines
  \-  `text` | Yes | String | The translated string
  \-  `language` | Yes | Language | IETF BCP 47 language code
| \- `color`<br/>*(added in v2.3-RC2)*| OPTIONAL| String| The color of the vehicle. <br><br>All words must be in lower case, without special characters, quotation marks, hyphens, underscores, commas, or dots. Spaces are allowed in case of a compound name. <br><br>Example <ul><li>green</li><li>dark blue</li></ul>
| \- `description`<br/>*(added in v3.0-Draft)*| OPTIONAL| Array| Customer-readable description of the vehicle type outlining special features or how-tos. An array with one object per supported language with the following keys:
&emsp;\-&nbsp; `text` | Yes | String | The translated text.
&emsp;\-&nbsp; `language` | Yes | Language | IETF BCP 47 language code.
\- `wheel_count`<br/>*(added in v2.3-RC2)* | OPTIONAL | Non-negative Integer | Number of wheels this vehicle type has.
\- `max_permitted_speed`<br/>*(added in v2.3-RC2)* | OPTIONAL | Non-negative Integer | The maximum speed in kilometers per hour this vehicle is permitted to reach in accordance with local permit and regulations.
\- `rated_power`<br/>*(added in v2.3-RC2)* | OPTIONAL | Non-negative Integer | The rated power of the motor for this vehicle type in watts.
Expand Down Expand Up @@ -578,6 +581,12 @@ Field Name | REQUIRED | Type | Defines
"language": "en"
}
],
"description": [
{
"text": "Extra comfortable seat with additional suspension.\n\nPlease be aware of the cargo box lock: you need to press it down before pulling it up again!",
"language": "en"
}
],
"wheel_count": 3,
"default_reserve_time": 30,
"return_constraint": "roundtrip_station",
Expand Down