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 vehicle type definitions #136

Merged
merged 37 commits into from
May 22, 2020
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
37 commits
Select commit Hold shift + click to select a range
83def47
first attempt at refactoring gbfs to allow vehicle type definitions
evansiroky Feb 19, 2019
053e604
in free_vehicle_status.json, rename vehicle_type to vehicle_type_id
evansiroky Feb 19, 2019
8715a98
remove no longer necessary reference to multiple vehicle types
evansiroky Feb 19, 2019
65fdf55
Refactor PR to a minimum viable product
evansiroky Sep 19, 2019
6a73469
Merge branch 'nabsa-master'
evansiroky Sep 19, 2019
81aa440
Include changes recommended by @kanagy
evansiroky Sep 24, 2019
9477593
Add additional form factor options for vehicle type
evansiroky Sep 25, 2019
37cb9a5
Refactor a few things to address discussion at GBFS developer workshop
evansiroky Oct 8, 2019
2d68f57
Add some more clarification and requirements for the range fields
evansiroky Oct 8, 2019
98f61a2
Improve a few small items in field documentation
evansiroky Oct 10, 2019
dde2a8f
Refactor station_status to allow reporting of individual vehicle details
evansiroky Oct 28, 2019
005333f
Try to clarify better when certain station_status fields are required.
evansiroky Nov 14, 2019
2df27ce
Modify propulsion_type field and add is_carryable field.
evansiroky Nov 23, 2019
33a0ae7
Merge branch 'nabsa-master'
evansiroky Nov 27, 2019
8f3906b
Include required version info in example json
evansiroky Nov 27, 2019
2698f13
Add gbfs_versions.json file to TOC
evansiroky Nov 27, 2019
3c89327
Merge commit '3fd004c7ea9a52896c1f204e79d489bccfcd48d7'
evansiroky Dec 6, 2019
167d6b7
Refactor fields about vehicle capacity/availability at stations
evansiroky Dec 6, 2019
071e0c6
Make num_bikes_available be required again
evansiroky Dec 6, 2019
becb09c
Merge branch 'nabsa-master'
evansiroky Jan 28, 2020
9a97518
Update field tables to latest format and add type information
evansiroky Jan 28, 2020
f0e9cf6
Merge branch 'nabsa-master'
evansiroky Feb 4, 2020
b8e46a9
Add fields describing energy potentials of vehicles
evansiroky Feb 21, 2020
314a332
Merge branch 'nabsa-master'
evansiroky Mar 4, 2020
e62ae18
Remove is_carryable field from vehicle_types.json file.
evansiroky Mar 4, 2020
fd404bb
Merge branch 'nabsa-master'
evansiroky Mar 6, 2020
b1be46c
Rename `bike` to `vehicle` in documentation wherever possible
evansiroky Mar 6, 2020
ba7c5cd
Revert back to vehicle range values
evansiroky Mar 11, 2020
fae9460
Rename field in station_status
evansiroky Mar 11, 2020
174ca6d
Merge branch 'nabsa-master'
evansiroky Mar 20, 2020
b318908
Update example JSON to have a future version number
evansiroky Mar 20, 2020
50b611d
Small formatting fix for consistency
evansiroky Mar 20, 2020
a03a7c6
Update boolean values and fix some merge problems.
evansiroky Mar 20, 2020
2010a60
A few more minor merge conflict fixes.
evansiroky Mar 20, 2020
a8e518a
Merge branch 'nabsa-master'
evansiroky Apr 6, 2020
d1b6626
Update gbfs.md
heidiguenin May 11, 2020
403e906
Add version labels, update MDS attribution & link
barbeau May 22, 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
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# General Bikeshare Feed Specification
# General Vehicleshare Feed Specification

Documentation for the General Bikeshare Feed Specification, a standardized data feed for bike share system availability.
Documentation for the General Vehicleshare Feed Specification (formerly General Bikeshare Feed Specification), a standardized data feed for vehicle share system availability.

## What is GBFS?
The General Bikeshare Feed Specification, known as GBFS, is the open data standard for bikeshare. GBFS makes real-time data feeds in a uniform format publicly available online, with an emphasis on findability.
## What is GVFS?
The General Vehicleshare Feed Specification, known as GVFS, is the open data standard for vehicleshare. GVFS makes real-time data feeds in a uniform format publicly available online, with an emphasis on findability.

Under the [North American Bikeshare Association’s](http://www.nabsa.net) leadership, GBFS has been developed by public, private sector and non-profit bike share system owners and operators, application developers, and technology vendors.
Original advance under the [North American Bikeshare Association’s](http://www.nabsa.net) leadership, GVFS has been developed by public, private sector and non-profit vehicle share system owners and operators, application developers, and technology vendors.

GBFS is intended as a specification for real-time, read-only data - any data being written back into individual bikeshare systems are excluded from this spec.
GVFS is intended as a specification for real-time, read-only data - any data being written back into individual vehicleshare systems are excluded from this spec.

The specification has been designed with the following concepts in mind:
* Provide the status of the system at this moment
Expand All @@ -17,45 +17,45 @@ The data in the specification contained in this document is intended for consump

## Read the spec

* [Current spec](gbfs.md)
* [Current spec](gvfs.md)
* [Original draft spec in a Google doc](https://docs.google.com/document/d/1BQPZCKpem4-n6lUQDD4Mi8E5hNZ0-lhY62IVtWuyhec/edit#heading=h.ic7i1m4gcev7) (reference only)

## Overview of the Change Process
GBFS is an open specification, developed and maintained by the community of producers and consumers of GBFS data.
The specification is not fixed or unchangeable. As the bikeshare industry evolves, it is expected that the specification will be extended by the GBFS community to include new features and capabilities over time. To manage the change process, the following guidelines have been established.
GVFS is an open specification, developed and maintained by the community of producers and consumers of GVFS data.
The specification is not fixed or unchangeable. As the vehicleshare industry evolves, it is expected that the specification will be extended by the GVFS community to include new features and capabilities over time. To manage the change process, the following guidelines have been established.

The general outline for changing the spec has 4 steps:
1. Propose a change by opening an issue at the GBFS GitHub repository.
2. Receive comments and feedback from the GBFS community and iterate on the proposed change. Discussion lasts for as long as the proposer feels necessary, but must be at least 7 calendar days
3. Find at least one GBFS producer to implement and test the proposed change.
4. Submit a final request-for-comments on the proposed change to the issue discussion. If no outstanding issues are identified after one week’s time, and there is general agreement that the proposed change is worthwhile and follows the GBFS guiding principles outlined below, the proposal will be officially adopted.
1. Propose a change by opening an issue at the GVFS GitHub repository.
2. Receive comments and feedback from the GVFS community and iterate on the proposed change. Discussion lasts for as long as the proposer feels necessary, but must be at least 7 calendar days
3. Find at least one GVFS producer to implement and test the proposed change.
4. Submit a final request-for-comments on the proposed change to the issue discussion. If no outstanding issues are identified after one week’s time, and there is general agreement that the proposed change is worthwhile and follows the GVFS guiding principles outlined below, the proposal will be officially adopted.


## Extensions Outside of the Specification ##
To accommodate the needs of feed producers and consumers prior to the adoption of a change, additional fields can be added to feeds even if these fields are not part of the official specification. It's strongly recommended that these additional fields be documented on the wiki page in this format:

Submitted by | Field Name | File Name | Required | Defines
---------- | ------------ | -------- | ------- |-------
publisher_name | field_name | name of GBFS end point where field is used | yes/no | description of purpose or use
publisher_name | field_name | name of GVFS end point where field is used | yes/no | description of purpose or use

## Guiding Principles
To preserve the original vision of GBFS, the following guiding principles should be taken into consideration when proposing extensions the spec:
To preserve the original vision of GVFS, the following guiding principles should be taken into consideration when proposing extensions the spec:

* **GBFS is a specification for real-time or semi-real-time, read-only data.**
* **GVFS is a specification for real-time or semi-real-time, read-only data.**
The spec is not intended for historical or archival data such as trip records.
The spec is about public information intended for bikeshare users.
The spec is about public information intended for vehicleshare users.

* **GBFS is targeted at providing transit information to the bikeshare end user.**
It’s primary purpose is to power tools for riders that will make bikesharing more accessible to users. GBFS is about public information. Producers and owners of GBFS data should take licensing and discoverability into account when publishing GBFS feeds.
* **GVFS is targeted at providing transit information to the vehicleshare end user.**
It’s primary purpose is to power tools for riders that will make vehiclesharing more accessible to users. GVFS is about public information. Producers and owners of GVFS data should take licensing and discoverability into account when publishing GVFS feeds.

* **Changes to the spec should be backwards-compatible.**
Caution should be taken to avoid making changes to the spec that would render existing feeds invalid.

* **Speculative features are discouraged.**
Each new addition to the spec adds complexity. We want to avoid additions to the spec that do not provide additional value to the bikeshare end user.
Each new addition to the spec adds complexity. We want to avoid additions to the spec that do not provide additional value to the vehicleshare end user.

## Systems Implementing GBFS
This list contains all known systems publishing GBFS feeds and is maintained by the GBFS community. If you have or are aware of a system that doesn’t appear on the list please add it.
## Systems Implementing GVFS
This list contains all known systems publishing GVFS feeds and is maintained by the GVFS community. If you have or are aware of a system that doesn’t appear on the list please add it.

* [systems.csv](systems.csv)

Expand Down
Loading