Skip to content

Commit

Permalink
v2.2-RC prep
Browse files Browse the repository at this point in the history
Removes subsequent version 3.0 from version history and removes v3.0 changes
changes version numbers in code examples to v2.1 /v2.2
  • Loading branch information
Mitch Vars committed Mar 18, 2021
1 parent 675c96b commit a6dfcc1
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 22 deletions.
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,13 @@ The data in the specification contained in this document is intended for consump
* [v2.1-RC2 (Release Candidate)](https://github.com/NABSA/gbfs/blob/v2.1-RC2/gbfs.md)
* [#261](https://github.com/NABSA/gbfs/pull/261) - Aggregate available vehicle_types at a station
* [#252](https://github.com/NABSA/gbfs/pull/252) - Extend system_pricing_plans.json
* ####**[v2.1: Current version](https://github.com/NABSA/gbfs/blob/v2.1/gbfs.md)**
* **[v2.1: Current version](https://github.com/NABSA/gbfs/blob/v2.1/gbfs.md)**
* [#136](https://github.com/NABSA/gbfs/pull/136) - Add vehicle type definitions
* [#219](https://github.com/NABSA/gbfs/pull/219) - Add geofencing, virtual station, and dockless support
* [#261](https://github.com/NABSA/gbfs/pull/261) - Aggregate available vehicle_types at a station
* [v2.2-RC (Release Candidate)](https://github.com/NABSA/gbfs/blob/v2.2-RC/gbfs.md)
* [#252](https://github.com/NABSA/gbfs/pull/252) - Extend system_pricing_plans.json
* [v3.0-RC (Release Candidate)](https://github.com/NABSA/gbfs/blob/master/gbfs.md)
* [#182](https://github.com/NABSA/gbfs/pull/182) - Require `license_url`, add attribution fields


## Governance & Overview of the Change Process
GBFS is an open specification, developed and maintained by the community of producers and consumers of GBFS data.
Expand Down
34 changes: 15 additions & 19 deletions gbfs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This document explains the types of files and data that comprise the General Bikeshare Feed Specification (GBFS) and defines the fields used in all of those files.

# Reference version
####This documentation refers to **v3.0-RC (release candidate)**. <br>
This documentation refers to **v2.2-RC (release candidate)**. <br>
**For the current version see [**version 2.1**](https://github.com/NABSA/gbfs/blob/v2.1/gbfs.md).** For past and upcoming versions see the [README](README.md#read-the-spec--version-history).

## Terminology
Expand Down Expand Up @@ -216,7 +216,7 @@ Field Name | REQUIRED | Type | Defines
{
"last_updated": 1609866247,
"ttl": 3600,
"version": "3.0",
"version": "2.1",
"data": {
"name": "Citi Bike",
"system_id": "citibike_com"
Expand All @@ -240,7 +240,7 @@ Field Name | REQUIRED | Type | Defines
{
"last_updated": 1609866247,
"ttl": 0,
"version": "3.0",
"version": "2.1",
"data": {
"en": {
"feeds": [
Expand Down Expand Up @@ -288,16 +288,16 @@ Field Name | REQUIRED | Type | Defines
{
"last_updated": 1609866247,
"ttl": 0,
"version": "3.0",
"version": "2.1",
"data": {
"versions": [
{
"version":"2.0",
"url":"https://www.example.com/gbfs/2/gbfs"
},
{
"version":"3.0",
"url":"https://www.example.com/gbfs/3/gbfs"
"version":"2.1",
"url":"https://www.example.com/gbfs/2-1/gbfs"
}
]
}
Expand All @@ -321,10 +321,7 @@ Field Name | REQUIRED | Type | Defines
`email` | OPTIONAL | Email | This OPTIONAL field SHOULD contain a single contact email address actively monitored by the operator’s customer service department. This email address SHOULD be a direct contact point where riders can reach a customer service representative.
`feed_contact_email` <br/>*(added in v1.1)* | OPTIONAL | Email | This OPTIONAL field SHOULD contain a single contact email for feed consumers to report technical issues with the feed.
`timezone` | Yes | Timezone | The time zone where the system is located.
`license_id` <br/>*(added in v3.0-RC)* | Conditionally REQUIRED | String | REQUIRED if the dataset is provided under a standard license. An identifier for a standard license from the [SPDX License List](https://spdx.org/licenses/). Provide `license_id` rather than `license_url` if the license is included in the SPDX License List. See the GBFS wiki for a [comparison of a subset of standard licenses](data-licenses.md). If the `license_id` and `license_url` fields are blank or omitted, this indicates that the feed is provided under the [Creative Commons Universal Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/legalcode).
`license_url` | Conditionally REQUIRED <br/>*(as of v3.0-RC)* | URL | REQUIRED if the dataset is provided under a customized license. A fully qualified URL of a page that defines the license terms for the GBFS data for this system. Do not specify a `license_url` if `license_id` is specified. If the `license_id` and `license_url` fields are blank or omitted, this indicates that the feed is provided under the [Creative Commons Universal Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/legalcode). *(as of v3.0-RC)*
`attribution_organization_name` <br/>*(added in v3.0-RC)* | OPTIONAL | String | If the feed license requires attribution, name of the organization to which attribution should be provided.
`attribution_url` <br/>*(added in v3.0-RC)* | OPTIONAL | URL | URL of the organization to which attribution should be provided.
`license_url` | Optional | URL | REQUIRED if the dataset is provided under a customized license. A fully qualified URL of a page that defines the license terms for the GBFS data for this system.
`rental_apps` <br/>*(added in v1.1)* | OPTIONAL | Object | Contains rental app information in the android and ios JSON objects.
\-&nbsp;`android` <br/>*(added in v1.1)* | OPTIONAL | Object | Contains rental app download and app discovery information for the Android platform in the `store_uri` and `discovery_uri` fields. See [examples](#examples-added-in-v11) of how to use these fields and [supported analytics](#analytics-added-in-v11).
&emsp;- `store_uri` <br/>*(added in v1.1)* | Conditionally REQUIRED | URI | URI where the rental Android app can be downloaded from. Typically this will be a URI to an app store such as Google Play. If the URI points to an app store such as Google Play, the URI SHOULD follow Android best practices so the viewing app can directly open the URI to the native app store app instead of a website. <br><br> If a `rental_uris`.`android` field is populated then this field is REQUIRED, otherwise it is OPTIONAL. <br><br>See the [Analytics](#analytics-added-in-v11) section for how viewing apps can report the origin of the deep link to rental apps. <br><br>Example value: `https://play.google.com/store/apps/details?id=com.abcrental.android`
Expand Down Expand Up @@ -376,7 +373,7 @@ Field Name | REQUIRED | Type | Defines
{
"last_updated": 1609866247,
"ttl": 0,
"version": "3.0",
"version": "2.1",
"data": {
"vehicle_types": [
{
Expand Down Expand Up @@ -437,7 +434,7 @@ Field Name | REQUIRED | Type | Defines
{
"last_updated": 1609866247,
"ttl": 0,
"version": "3.0",
"version": "2.1",
"data": {
"stations": [
{
Expand All @@ -461,7 +458,7 @@ Field Name | REQUIRED | Type | Defines
{
"last_updated":1609866247,
"ttl":0,
"version":"3.0",
"version":"2.1",
"data":{
"stations":[
{
Expand Down Expand Up @@ -539,7 +536,7 @@ Field Name | REQUIRED | Type | Defines
{
"last_updated": 1609866247,
"ttl": 0,
"version": "3.0",
"version": "2.2",
"data": {
"stations": [
{
Expand Down Expand Up @@ -600,7 +597,6 @@ Field Name | REQUIRED | Type | Defines
---|---|---|---
`bikes` | Yes | Array | Array that contains one object per vehicle that is currently stopped as defined below.
\-&nbsp;`bike_id` | Yes | ID | Identifier of a vehicle. The `bike_id` identifier MUST be rotated to a random string after each trip to protect user privacy *(as of v2.0)*. Use of persistent vehicle IDs poses a threat to user privacy. The `bike_id` identifier SHOULD only be rotated once per trip.
\-&nbsp;`system_id` <br/>*(added in v3.0-RC)* | Conditionally REQUIRED | ID | Identifier referencing the `system_id` field in [system_information.json](#system_informationjson). REQUIRED in the case of feeds that specify free (undocked) bikes and define systems in [system_information.json](#system_informationjson).
\-&nbsp;`lat` | Conditionally REQUIRED <br/>*(as of v2.1)* | Latitude | Latitude of the vehicle in decimal degrees. *(as of v2.1)* This field is REQUIRED if `station_id` is not provided for this vehicle (free floating). This field SHOULD have a precision of 6 decimal places (0.000001). See [Coordinate Precision](#coordinate-precision).
\-&nbsp;`lon` | Conditionally REQUIRED <br/>*(as of v2.1)* | Longitude | Longitude of the vehicle. *(as of v2.1)* This field is REQUIRED if `station_id` is not provided for this vehicle (free floating).
\-&nbsp;`is_reserved` | Yes | Boolean | Is the vehicle currently reserved? <br /><br /> `true` - Vehicle is currently reserved. <br /> `false` - Vehicle is not currently reserved.
Expand All @@ -621,7 +617,7 @@ Field Name | REQUIRED | Type | Defines
{
"last_updated":1609866247,
"ttl":0,
"version":"3.0",
"version":"2.2",
"data":{
"bikes":[
{
Expand Down Expand Up @@ -665,7 +661,7 @@ Field Name | REQUIRED | Type | Defines
{
"last_updated": 1609866247,
"ttl": 86400,
"version": "3.0",
"version": "2.2",
"data": {
"rental_hours": [
{
Expand Down Expand Up @@ -795,7 +791,7 @@ The user does not pay more than the base price for the first 10 km. After 10 km
{
"last_updated":1609866247,
"ttl":0,
"version":"3.0",
"version":"2.2",
"data":{
"plans":{
"plan_id":"plan2",
Expand Down Expand Up @@ -833,7 +829,7 @@ This example demonstrates a pricing scheme that has a rate both by minute and by
{
"last_updated":1609866247,
"ttl":0,
"version":"3.0",
"version":"2.2",
"data":{
"plans":{
"plan_id":"plan3",
Expand Down

0 comments on commit a6dfcc1

Please sign in to comment.