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.

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

Jump to bottom

Additions and modifications to inventory of past, current and upcoming versions #206

Merged
merged 6 commits into from
Jan 3, 2020
Merged

Additions and modifications to inventory of past, current and upcoming versions #206

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
502acd1
Checking in changes - versioning and changes - v1.1
antrim Jan 3, 2020
cc445c5
add link to master branch for v1.1
antrim Jan 3, 2020
b99c398
README.md: rearrange the versions
antrim Jan 3, 2020
7b7c5ab
add links to PRs
antrim Jan 3, 2020
600a50f
Update gbfs.md: all versions to v1.1
antrim Jan 3, 2020
1b02551
Corrections
antrim Jan 3, 2020
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
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,10 +25,22 @@ The specification has been designed with the following concepts in mind:

The data in the specification contained in this document is intended for consumption by clients intending to provide real-time (or semi-real-time) transit advice and is designed as such.

## Read the spec

* [Current spec](gbfs.md)
* [Original draft spec in a Google doc](https://docs.google.com/document/d/1BQPZCKpem4-n6lUQDD4Mi8E5hNZ0-lhY62IVtWuyhec/edit#heading=h.ic7i1m4gcev7) (reference only)
## Read the spec & version history
* **[v1.0: Current Version](https://github.com/NABSA/gbfs/blob/df473ca4adbff982d67b50ac00b625191591d8f8/gbfs.md)**
* 2019 December 20 - GBFS copyright [transfered to NABSA](https://github.com/NABSA/gbfs/commit/b1260b9c59eeff810a62e0aedc72ce1d4fb8f3ab)
* 2015 November 05 - GBFS V1.0 Adopted by NABSA board - [Original draft spec in a Google doc](https://docs.google.com/document/d/1BQPZCKpem4-n6lUQDD4Mi8E5hNZ0-lhY62IVtWuyhec/edit#heading=h.ic7i1m4gcev7) (reference only)
* 2015 August - Latest changes incorporated and name change to GBFS (comments from Motivate, 8D, others)
* 2015 June - Proposed refinements (prepared by Jesse Chan-Norris on behalf of Motivate)
* 2015 January - NABSA Draft (prepared by Mitch Vars)
* **[v1.1: MINOR Release Candidate](https://github.com/NABSA/gbfs/blob/master/gbfs.md)**
* [#25](https://github.com/NABSA/gbfs/pull/25) - Add deep links for iOS, Android, and web apps
* [#181](https://github.com/NABSA/gbfs/pull/181) - Add feed\_contact\_email field to system\_information.json
* [#188](https://github.com/NABSA/gbfs/pull/188) - GBFS documentation versioning and and feed conformance
* **[v2.0: MAJOR Release Candidate](https://github.com/NABSA/gbfs/labels/v2.0)**
* [#182](https://github.com/NABSA/gbfs/pull/182) - Require license\_url, add attribution fields
* [#189](https://github.com/NABSA/gbfs/pull/189) - Require autodiscovery gbfs.json file, define feed names
* [#195](https://github.com/NABSA/gbfs/pull/195) - Clarify num\_bikes\_available and num\_docks\_available
* [#196](https://github.com/NABSA/gbfs/pull/196) - Change boolean from 1/0 to true/false

## 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
31 changes: 8 additions & 23 deletions gbfs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# General Bikeshare Feed Specification (GBFS)
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 **version 1.1**. For past and upcoming versions see the [README](README.md).

## Table of Contents

* [Revision History](#revision-history)
Expand All @@ -19,13 +22,6 @@ This document explains the types of files and data that comprise the General Bik
* [system_pricing_plans.json](#system_pricing_plansjson)
* [system_alerts.json](#system_alertsjson)
* [Deep Links - Analytics and Examples](#Deep-Links)
* [Possible Future Enhancements](#possible-future-enhancements)

## Revision History
* 11/05/2015 - GBFS V1.0 Adopted by NABSA board
* 08/2015 - Latest changes incorporated and name change to GBFS (comments from Motivate, 8D, others)
* 06/2015 - Proposed refinements (prepared by Jesse Chan-Norris on behalf of Motivate)
* 01/2015 - NABSA Draft (prepared by Mitch Vars)

## Introduction
This specification has been designed with the following concepts in mind:
Expand All @@ -35,7 +31,7 @@ This specification has been designed with the following concepts in mind:

Historical data, including station details and ride data is to be provided by a more compact specification designed specifically for such archival purposes. The data in the specification contained in this document is intended for consumption by clients intending to provide real-time (or semi-real-time) transit advice and is designed as such.

## Versioning
## Version endpoints
The version of the GBFS specification to which a feed conforms is declared in the `version` field in all files. See [Output Format](#output-format).

GBFS Best Practice defines that:
Expand Down Expand Up @@ -120,7 +116,7 @@ Example:
{
"last_updated": 1434054678,
"ttl": 3600,
"version": "1.0",
"version": "1.1",
"data": {
"name": "Citi Bike",
"system_id": "citibike_com"
Expand All @@ -145,7 +141,7 @@ Example:
{
"last_updated": 1434054678,
"ttl": 0,
"version": "1.0",
"version": "1.1",
"data": {
"en": {
"feeds": [
Expand Down Expand Up @@ -190,7 +186,7 @@ _versions_ | Yes | Array that contains one object, as defin
{
"last_updated": 1434054678,
"ttl": 0,
"version": "1.0",
"version": "1.1",
"data": {
"versions":
[
Expand Down Expand Up @@ -302,7 +298,7 @@ Example:
{
"last_updated": 1434054678,
"ttl": 0,
"version": "1.0",
"version": "1.1",
"data": {
"rental_hours": [
{
Expand Down Expand Up @@ -512,17 +508,6 @@ Note that the Android URI and iOS Universal Link URLs don’t necessarily use th
...
```

## Possible Future Enhancements
antrim marked this conversation as resolved.
Show resolved Hide resolved
There are some items that were proposed in an earlier version of this document but which do not fit into the current specification. They are collected here for reference and for possible discussion and inclusion in this or a future version.

* system_information.json
* _system_data_ - Removed due to a lack of specificity; if metadata about the location of URLs is required / desired, the proposal is to include this in a separate feed_info.json feed which would contain an array with all of the feeds in addition to other feed information such as a feed version (if necessary)
* _equipment_ - Removed due to a lack of specificity behind the intent of this field and a question about the actual relevance to the public
* _jurisdictions_ - It is believed that the need for this field is negated by the presence of the system_regions.json feed

* station_status.json
* need a way to distinguish between multiple bike types at a station if/when hybrid systems using e-bikes become available

## Disclaimers

_Apple Pay, PayPass and other third-party product and service names are trademarks or registered trademarks of their respective owners._
Expand Down