Skip to content

Release GBFS v3.1-RC3 #867

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.

Sign up for GitHub

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

Open
richfab wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Release GBFS v3.1-RC3 #867

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e653827
File description: specify endpoint timeout (#715)
AntoineAugusti May 6, 2026
19c3eb2
Minimum age requirement (#799)
mplsmitch May 6, 2026
8626329
Update documentation version to v3.1-RC3
richfab May 6, 2026
ce0c187
Update versions in README file
richfab May 6, 2026
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
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Release Candidates will receive *Current Version* status when they have been ful

| Version | Type | Release Date | Status | JSON Schema | Release Notes |
|:---:|:-----:|----------------|----------------------------|----------------------------------------------------------------------------------------|---------------------|
| [v3.1-RC2](https://github.com/MobilityData/gbfs/blob/v3.1-RC2/gbfs.md) | MINOR | May 28, 2025 | :white_check_mark: Ready for implementation | [v3.1-RC2 Schema](https://github.com/MobilityData/gbfs-json-schema/tree/master/v3.1-RC2) | [v3.1-RC2 Release Notes](https://github.com/MobilityData/gbfs/releases/tag/v3.1-RC2) |
| [v3.1-RC3](https://github.com/MobilityData/gbfs/blob/v3.1-RC3/gbfs.md) | MINOR | TBD | :white_check_mark: Ready for implementation | [v3.1-RC3 Schema](https://github.com/MobilityData/gbfs-json-schema/tree/master/v3.1-RC3) | [v3.1-RC3 Release Notes](https://github.com/MobilityData/gbfs/releases/tag/v3.1-RC3) |

### Past Version Releases
Past versions with *Supported* status MAY be patched to correct bugs or vulnerabilities but new features will not be introduced.<br />
Expand Down
8 changes: 7 additions & 1 deletion gbfs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ This document explains the types of files and data that comprise the General Bik

## Reference version

This documentation refers to **v3.1-RC2**.
This documentation refers to **v3.1-RC3**.

For past and upcoming versions see the [README](https://github.com/MobilityData/gbfs/blob/master/README.md#current-version-recommended).

Expand Down Expand Up @@ -124,6 +124,7 @@ Hours and dates of operation MUST be published even in cases where services are

* Files are distributed as individual HTTP endpoints.
* All endpoints MUST use HTTPS
* All endpoints SHOULD respond to HTTP requests in less than 1 second
* REQUIRED files MUST NOT 404. They MUST return a properly formatted JSON file as defined in [Output Format](#output-format).
* OPTIONAL files MAY 404. A 404 of an OPTIONAL file SHOULD NOT be considered an error.
* HTTP responses SHOULD include the [`ETag` HTTP header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag).
Expand Down Expand Up @@ -638,6 +639,7 @@ Field Name | REQUIRED | Type | Defines
`vehicle_types[].rated_power`<br/>*(added in v2.3)* | OPTIONAL | Non-negative Integer | The rated power of the motor for this vehicle type in watts.
`vehicle_types[].default_reserve_time`<br/>*(added in v2.3)* | Conditionally REQUIRED | Non-negative Integer | REQUIRED if `reservation_price_per_min` or `reservation_price_flat_rate` are defined. Maximum time in minutes that a vehicle can be reserved before a rental begins. When a vehicle is reserved by a user, the vehicle remains locked until the rental begins. During this time the vehicle is unavailable and cannot be reserved or rented by other users. The vehicle status in `vehicle_status.json` MUST be set to `is_reserved = true`. If the value of `default_reserve_time` elapses without a rental beginning, the vehicle status MUST change to `is_reserved = false`. If `default_reserve_time` is set to `0`, the vehicle type cannot be reserved.
`vehicle_types[].return_constraint`<br/>*(as of v2.3)*| OPTIONAL | Enum | The conditions for returning the vehicle at the end of the rental. <br /><br />Current valid values are:<br /><ul><li>`free_floating` _(The vehicle can be returned anywhere permitted within the service area. Note that the vehicle is subject to rules in `geofencing_zones.json` if defined.)_</li><li>`roundtrip_station` _(The vehicle has to be returned to the same station from which it was initially rented. Note that a specific station can be assigned to the vehicle in `vehicle_status.json` using `home_station`.)_</li><li>`any_station` _(The vehicle has to be returned to any station within the service area.)_</li><li>`hybrid` (The vehicle can be returned to any station, or anywhere else permitted within the service area. Note that the vehicle is subject to rules in `geofencing_zones.json` if defined.)</li>
`vehicle_types[].min_age`<br/>*(added in v3.1-RC3)*| OPTIONAL | Non-negative Integer | Minimum age required to use this vehicle.
`vehicle_types[].vehicle_assets`<br/>*(added in v2.3)*| OPTIONAL | Object | Object containing the branding information for this vehicle type.
`vehicle_types[].vehicle_assets.icon_url`<br/>*(added in v2.3)*| REQUIRED | URL | A fully qualified URL pointing to the location of a graphic icon file that MAY be used to represent this vehicle type on maps and in other applications. File MUST be in SVG V1.1 format and MUST be either square or round.
`vehicle_types[].vehicle_assets.icon_url_dark`<br/>*(added in v2.3)*| OPTIONAL | URL | A fully qualified URL pointing to the location of a graphic icon file to be used to represent this vehicle type when in dark mode on maps and in other applications. File MUST be in SVG V1.1 format and MUST be either square or round.
Expand Down Expand Up @@ -667,6 +669,7 @@ Field Name | REQUIRED | Type | Defines
"wheel_count": 2,
"default_reserve_time": 30,
"return_constraint": "any_station",
"min_age": 14,
"vehicle_assets": {
"icon_url": "https://www.example.com/assets/icon_bicycle.svg",
"icon_url_dark": "https://www.example.com/assets/icon_bicycle_dark.svg",
Expand Down Expand Up @@ -698,6 +701,7 @@ Field Name | REQUIRED | Type | Defines
"wheel_count": 3,
"default_reserve_time": 30,
"return_constraint": "roundtrip_station",
"min_age": 16,
"vehicle_assets": {
"icon_url": "https://www.example.com/assets/icon_cargobicycle.svg",
"icon_url_dark": "https://www.example.com/assets/icon_cargobicycle_dark.svg",
Expand Down Expand Up @@ -726,6 +730,7 @@ Field Name | REQUIRED | Type | Defines
"default_reserve_time": 30,
"max_range_meters": 12345,
"return_constraint": "free_floating",
"min_age": 18,
"vehicle_assets": {
"icon_url": "https://www.example.com/assets/icon_escooter.svg",
"icon_url_dark": "https://www.example.com/assets/icon_escooter_dark.svg",
Expand Down Expand Up @@ -759,6 +764,7 @@ Field Name | REQUIRED | Type | Defines
"default_reserve_time": 0,
"max_range_meters": 523992,
"return_constraint": "roundtrip_station",
"min_age": 18,
"vehicle_accessories": [
"doors_4",
"automatic",
Expand Down
Loading