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

Update policy guides to v3.0 #90

Merged
merged 5 commits into from
Apr 16, 2024
Merged
Show file tree
Hide file tree
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
10 changes: 5 additions & 5 deletions docs/en/learn/guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ This guide is intended for technical teams of shared mobility services. In this

The General Bikeshare Feed Specification (GBFS) was created in 2014 by [Mitch Vars](https://github.com/mplsmitch), which was then adopted by [NABSA](https://nabsa.net/), to standardize the way shared bike systems communicate with trip planning applications.

Powered by MobilityData since 2019 and officially transferred to MobilityData in 2022, GBFS has evolved to allow [over 900](https://github.com/MobilityData/gbfs/blob/master/systems.csv) docked and dockless systems worldwide such as scooters, mopeds and shared cars to appear in trip planning applications.
Powered by MobilityData since 2019 and officially transferred to MobilityData in 2022, GBFS has evolved to allow [over 800](https://github.com/MobilityData/gbfs/blob/master/systems.csv) docked and dockless systems worldwide such as scooters, mopeds and shared cars to appear in trip planning applications.

<img src="../../img/gbfs_producer_consumer_logos.png" width="1000px" alt="GBFS producer consumer logos">


_GBFS is a standardized data format used by [over 900](https://github.com/MobilityData/gbfs/blob/master/systems.csv) shared mobility services worldwide to appear in trip planners and other consuming applications._
_GBFS is a standardized data format used by [over 800](https://github.com/MobilityData/gbfs/blob/master/systems.csv) shared mobility services worldwide to appear in trip planners and other consuming applications._

## Overview of a GBFS feed

Expand Down Expand Up @@ -87,7 +87,7 @@ Example of [station_status.json](https://github.com/MobilityData/gbfs/blob/maste
{
"last_updated": "2023-07-30T13:45:29+02:00",
"ttl": 0,
"version": "3.0-RC",
"version": "3.0",
"data": {
"stations": [
{
Expand Down Expand Up @@ -131,7 +131,7 @@ Example of [vehicle_status.json](https://github.com/MobilityData/gbfs/blob/maste
{
"last_updated": "2023-07-30T13:45:29+02:00",
"ttl": 0,
"version": "3.0-RC",
"version": "3.0",
"data": {
"vehicles": [
{
Expand Down Expand Up @@ -165,7 +165,7 @@ To protect user privacy, vehicles in active rental should not be included in thi

#### Use the Current Version of GBFS

Use the [Current Version](https://github.com/MobilityData/gbfs/blob/master/README.md#current-version-recommended) of the specification to benefit from the most coverage of vehicle types and features. This guide uses version 3.0-RC of the GBFS specification. [Release Candidates](https://github.com/MobilityData/gbfs/wiki/Release-Candidate-Feature-Implementation) (-RC) are versions that will receive Current Version status when they have been fully implemented in public feeds.
Use the [Current Version](https://github.com/MobilityData/gbfs/blob/master/README.md#current-version-recommended) of the specification to benefit from the most coverage of vehicle types and features. This guide uses version 3.0 of the GBFS specification. [Release Candidates](https://github.com/MobilityData/gbfs/blob/master/README.md#release-candidates) (-RC) are versions that will receive Current Version status when they have been fully implemented in public feeds.

#### Generate a data model from the JSON schema

Expand Down
51 changes: 18 additions & 33 deletions docs/en/learn/white-papers/data-policy-europe.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ When developing data policies, it is a good idea to gather input from subject ma
GBFS is designed to accommodate the needs of a wide variety of mobility platforms and use cases, from traditional docked bikeshare to free floating bikes, scooters, and other vehicles. The specification consists of thirteen files or endpoints that contain different types of mobility data. Some of these files and their associated fields are required in order to be compliant with the specification, while others are optional. Which of these files are required by the specification depends on the specific type of mobility system being represented. Optional files and fields provide additional data for specific purposes and use cases. Municipalities may need to require some of these optional files or fields in their regulations to provide additional information in support of travelers, municipal goals, or other needs.


### Overview of GBFS files
### Overview of GBFS Files

<table>
<tr>
<td><strong>File Name</strong>
Expand All @@ -68,6 +69,12 @@ GBFS is designed to accommodate the needs of a wide variety of mobility platform
<td><strong>Required</strong> – This file is an index of URLs for all other files published as part of a GBFS API. To make data available to the public, a link to this file should be published on the city or agency website or open data portal.
</td>
</tr>
<tr>
<td><strong>manifest.json</strong>
</td>
<td><strong>Optional</strong> – This file is an index of gbfs.json URLs for each GBFS data set produced by a publisher.
</td>
</tr>
<tr>
<td><strong>gbfs_versions.json</strong>
</td>
Expand All @@ -83,7 +90,7 @@ GBFS is designed to accommodate the needs of a wide variety of mobility platform
<tr>
<td><strong>vehicle_types.json</strong>
</td>
<td><strong>Conditionally Required</strong> – This file is required of systems that include information about vehicle types in the free_bike_status file or its equivalent. This file should be published by systems offering multiple vehicle types for rental, for example pedal bikes and ebikes. If this file is not published, all vehicles in the feed are assumed to be non-motorized bicycles.
<td><strong>Conditionally Required</strong> – This file is required of systems that include information about vehicle types in the vehicle_status file or its equivalent. This file should be published by systems offering multiple vehicle types for rental, for example pedal bikes and ebikes. If this file is not published, all vehicles in the feed are assumed to be non-motorized bicycles.
</td>
</tr>
<tr>
Expand All @@ -99,24 +106,11 @@ GBFS is designed to accommodate the needs of a wide variety of mobility platform
</td>
</tr>
<tr>
<td><strong>free_bike_status.json</strong>
<td><strong>vehicle_status.json</strong>
</td>
<td><strong>Conditionally Required</strong> – This file (or its equivalent) is required for free floating (dockless) or hybrid (docked/dockless) vehicles. It is optional for station based (docked) vehicles. This is a real-time file that shows the current location, availability status, and other attributes of individual vehicles in a fleet. May optionally be used in station based (docked) systems to publish information on vehicle types, charge or fuel levels, and other vehicle attributes. This data may be used to determine the number of vehicles deployed, their availability for rental, and their distribution within the service area.
</td>
</tr>
<tr>
<td><strong>system_hours.json</strong>
</td>
<td><strong>Optional</strong> – This file is used to indicate hours and days of operation when vehicles are available for rent. It should be required if the service is not available for 24 hours a day, 7 days a week. If this file is not published, it indicates that vehicles are available for rental 24/7. (This file may be deprecated in the future, in which case system hours should be published using the method described in the appropriate version.)
</td>
</tr>
<tr>
<td><strong>system_calendar.json</strong>
</td>
<td><strong>Optional</strong> – This optional file should be required of systems that operate seasonally or that do not offer continuous year-round service. (This file may be deprecated in the future in which case system hours should be published using the method described in the appropriate version.)
</td>
</tr>
<tr>
<td><strong>system_regions.json</strong>
</td>
<td><strong>Optional</strong> – This file is used to define regions within a system. It may be used to support reporting in systems that encompass multiple jurisdictions.
Expand Down Expand Up @@ -153,7 +147,9 @@ At minimum, a shared mobility data policy should:

**Sample policy language**

>_[COMPANY] shall provide a publicly accessible API that conforms to the General Bikeshare Feed Specification (GBFS) current version available at [https://github.com/MobilityData/gbfs](https://github.com/MobilityData/gbfs/blob/master/gbfs.md) . [COMPANY] must make the API available to the public on the open internet without requiring authentication._
>_[COMPANY] shall provide a publicly accessible API that conforms to the General Bikeshare Feed Specification (GBFS) current version available at [https://github.com/MobilityData/gbfs](https://github.com/MobilityData/gbfs/blob/master/gbfs.md)._
>
>_[COMPANY] must make the API available to the public on the open internet without requiring authentication._
>
>_[COMPANY] shall inform [PERMITTING AGENCY] of the URL for the gbfs.json endpoint prior to deploying vehicles. [COMPANY] must notify [PERMITTING AGENCY] at least 30 days prior to changing the URL of the gbfs.json endpoint._
>
Expand All @@ -162,9 +158,10 @@ At minimum, a shared mobility data policy should:
>_Upon release of a new version of GBFS, [COMPANY] must update API to the new version within [XX<sup>1</sup>] days unless prior arrangement has been made with [PERMITTING AGENCY]._
>
>_GBFS API must contain the following endpoints and all fields required under the GBFS specification:_
>
>* _gbfs.json_
>* _system_information.json_
>* _[ list of additional endpoints e.g. station_information.json, station_status.json, free_bike status.json or its equivalent, etc.]_
>* _[ list of additional endpoints e.g. station_information.json, station_status.json, vehicle_status.json or its equivalent, etc.]_
>
>_In addition to the fields required under the specification the following files must also contain these optional fields:_
>
Expand Down Expand Up @@ -201,26 +198,14 @@ GBFS is the only open data standard, used internationally, to be recognized by C

* [GBFS Repo on GitHub](https://github.com/MobilityData/gbfs)
* [GBFS Public Slack Channel](https://share.mobilitydata.org/slack)
* [NeTEx](https://data4pt.org/wiki/NeTEX)
* [SIRI](https://data4pt.org/wiki/SIRI)
* [NeTEx](https://data4pt.org/w/index.php?title=NeTEX)
* [SIRI](https://data4pt.org/w/index.php?title=SIRI)

MobilityData Shared Mobility team email: <[email protected]>

## Acknowledgements

**Shared Mobility Team at MobilityData**

[Heidi Guenin](https://www.linkedin.com/in/heidiguenin/) - Director, Product, Shared Mobility

[Mitch Vars](https://www.linkedin.com/in/mitchvars/) - Senior, Shared Mobility Specialist

[Josée Sabourin](https://www.linkedin.com/in/josee-sabourin/) - Shared Mobility Specialist

**Partnerships, Europe at MobilityData**

Tu-Tho Thai - Director, Partnerships Europe

Newton Davis - Partnerships Europe
[Heidi Guenin](https://www.linkedin.com/in/heidiguenin/), [Mitch Vars](https://www.linkedin.com/in/mitchvars/), [Josée Sabourin](https://www.linkedin.com/in/josee-sabourin/), [Tu-Tho Thai](https://www.linkedin.com/in/tuthothai/) and [Newton Davis](https://www.linkedin.com/in/newtondavis/).

**Reviewers**

Expand Down
39 changes: 15 additions & 24 deletions docs/en/learn/white-papers/data-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Since it was first established in 2015, GBFS has become the de facto standard fo
**Policymakers should require public GBFS APIs when permitting or licensing shared mobility operations.**

GBFS provides a common language for shared mobility operators to share information about options available to travelers. GBFS includes information about vehicles (bicycles, scooters, moped, and cars), stations, and more:

* Vehicle, station, and dock locations and availability
* Vehicle characteristics – type of power, distance that can be traveled on remaining charge
* Geofenced areas for rules related to speed, parking, and prohibited zones
Expand Down Expand Up @@ -68,6 +69,12 @@ GBFS is designed to accommodate the needs of a wide variety of mobility platform
<td><strong>Required</strong> – This file is an index of URLs for all other files published as part of a GBFS API. To make data available to the public, a link to this file should be published on the city or agency website or open data portal.
</td>
</tr>
<tr>
<td><strong>manifest.json</strong>
</td>
<td><strong>Optional</strong> – This file is an index of gbfs.json URLs for each GBFS data set produced by a publisher.
</td>
</tr>
<tr>
<td><strong>gbfs_versions.json</strong>
</td>
Expand All @@ -83,7 +90,7 @@ GBFS is designed to accommodate the needs of a wide variety of mobility platform
<tr>
<td><strong>vehicle_types.json</strong>
</td>
<td><strong>Conditionally Required</strong> – This file is required of systems that include information about vehicle types in the free_bike_status file or its equivalent. This file should be published by systems offering multiple vehicle types for rental, for example pedal bikes and ebikes. If this file is not published, all vehicles in the feed are assumed to be non-motorized bicycles.
<td><strong>Conditionally Required</strong> – This file is required of systems that include information about vehicle types in the vehicle_status file or its equivalent. This file should be published by systems offering multiple vehicle types for rental, for example pedal bikes and ebikes. If this file is not published, all vehicles in the feed are assumed to be non-motorized bicycles.
</td>
</tr>
<tr>
Expand All @@ -99,24 +106,11 @@ GBFS is designed to accommodate the needs of a wide variety of mobility platform
</td>
</tr>
<tr>
<td><strong>free_bike_status.json</strong>
<td><strong>vehicle_status.json</strong>
</td>
<td><strong>Conditionally Required</strong> – This file (or its equivalent) is required for free floating (dockless) or hybrid (docked/dockless) vehicles. It is optional for station based (docked) vehicles. This is a real-time file that shows the current location, availability status, and other attributes of individual vehicles in a fleet. May optionally be used in station based (docked) systems to publish information on vehicle types, charge or fuel levels, and other vehicle attributes. This data may be used to determine the number of vehicles deployed, their availability for rental, and their distribution within the service area.
</td>
</tr>
<tr>
<td><strong>system_hours.json</strong>
</td>
<td><strong>Optional</strong> – This file is used to indicate hours and days of operation when vehicles are available for rent. It should be required if the service is not available for 24 hours a day, 7 days a week. If this file is not published, it indicates that vehicles are available for rental 24/7. (This file may be deprecated in the future, in which case system hours should be published using the method described in the appropriate version.)
</td>
</tr>
<tr>
<td><strong>system_calendar.json</strong>
</td>
<td><strong>Optional</strong> – This optional file should be required of systems that operate seasonally or that do not offer continuous year-round service. (This file may be deprecated in the future in which case system hours should be published using the method described in the appropriate version.)
</td>
</tr>
<tr>
<td><strong>system_regions.json</strong>
</td>
<td><strong>Optional</strong> – This file is used to define regions within a system. It may be used to support reporting in systems that encompass multiple jurisdictions.
Expand Down Expand Up @@ -154,7 +148,9 @@ At minimum, a shared mobility data policy should:

**Sample policy language**

>_[COMPANY] shall provide a publicly accessible API that conforms to the General Bikeshare Feed Specification (GBFS) current version available at [https://github.com/MobilityData/gbfs](https://github.com/MobilityData/gbfs/blob/master/gbfs.md) . [COMPANY] must make the API available to the public on the open internet without requiring authentication._
>_[COMPANY] shall provide a publicly accessible API that conforms to the General Bikeshare Feed Specification (GBFS) current version available at [https://github.com/MobilityData/gbfs](https://github.com/MobilityData/gbfs/blob/master/gbfs.md)._
>
>_[COMPANY] must make the API available to the public on the open internet without requiring authentication._
>
>_[COMPANY] shall inform [PERMITTING AGENCY] of the URL for the gbfs.json endpoint prior to deploying vehicles. [COMPANY] must notify [PERMITTING AGENCY] at least 30 days prior to changing the URL of the gbfs.json endpoint._
>
Expand All @@ -163,9 +159,10 @@ At minimum, a shared mobility data policy should:
>_Upon release of a new version of GBFS, [COMPANY] must update API to the new version within [XX<sup>1</sup>] days unless prior arrangement has been made with [PERMITTING AGENCY]._
>
>_GBFS API must contain the following endpoints and all fields required under the GBFS specification:_
>
>* _gbfs.json_
>* _system_information.json_
>* _[ list of additional endpoints e.g. station_information.json, station_status.json, free_bike status.json or its equivalent, etc.]_
>* _[ list of additional endpoints e.g. station_information.json, station_status.json, vehicle_status.json or its equivalent, etc.]_
>
>_In addition to the fields required under the specification the following files must also contain these optional fields:_
>
Expand All @@ -189,13 +186,7 @@ MobilityData Shared Mobility team email: <[email protected]>

## **Acknowledgement**

**Shared Mobility Team at MobilityData**

[Heidi Guenin](https://www.linkedin.com/in/heidiguenin/) - Director, Product, Shared Mobility

[Mitch Vars](https://www.linkedin.com/in/mitchvars/) - Senior, Shared Mobility Specialist

[Josée Sabourin](https://www.linkedin.com/in/josee-sabourin/) - Shared Mobility Specialist
[Heidi Guenin](https://www.linkedin.com/in/heidiguenin/), [Mitch Vars](https://www.linkedin.com/in/mitchvars/) and [Josée Sabourin](https://www.linkedin.com/in/josee-sabourin/).

**Reviewers**

Expand Down
5 changes: 2 additions & 3 deletions docs/en/specification/index.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# Specification

<div class="landing-page">
<a class="button" href="reference">Latest Reference (v3.0-RC2)</a><a class="button" href="https://github.com/MobilityData/gbfs/issues">Change Proposals</a><a class="button" href="process">Governance Process</a>
<a class="button" href="reference">Latest Reference (v3.0)</a><a class="button" href="https://github.com/MobilityData/gbfs/issues">Change Proposals</a><a class="button" href="process">Governance Process</a>
</div>

<hr>

## Versions of this documentation

- [Latest](reference) - Version 3.0-RC2
- [v3.0-RC](https://github.com/MobilityData/gbfs/blob/v3.0-RC/gbfs.md) - Version 3.0-RC
- [Latest](reference) - Version 3.0
- [v2.3](https://github.com/MobilityData/gbfs/blob/v2.3/gbfs.md) - Version 2.3
- [v2.2](https://github.com/MobilityData/gbfs/blob/v2.2/gbfs.md) - Version 2.2
- [v2.1](https://github.com/MobilityData/gbfs/blob/v2.1/gbfs.md) - Version 2.1
Expand Down
Loading