Skip to content

Commit

Permalink
Clarify num_bikes_available and num_docks_available definitions (#195)
Browse files Browse the repository at this point in the history 
Breaking change: will be part of v2.0-RC

* Update gbfs.md

Addressing issue #94

* Update gbfs.md

* num_docks_available update

Changed to conditionally required to reflect feedback about virtual stations

* formatting fix - field names in fixed width text

* station_status.json: Description

add back in the description that was removed

* formatting - spacing -- free_bike_status table

Eliminate new spaces that were showing up in the diff

Co-authored-by: Aaron Antrim <[email protected]>
  • Loading branch information
@heidiguenin @antrim
2 people authored and antrim committed Jan 27, 2020
1 parent dc99da3 commit 643d735
Showing 1 changed file with 12 additions and 13 deletions.
25 changes: 12 additions & 13 deletions gbfs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -282,19 +282,18 @@ _`stations`_ | Yes | Array | Array

### station_status.json
Describes the capacity and rental availability of a station.

Field Name | Required | Type | Defines
----------------------------- | ----------| ---------------------- | ------------------
_`stations`_ | Yes | Array | Array that contains one object per station in the system as defined below.
\-&nbsp;`station_id` | Yes | ID | Identifier of a station see [station_information.json](#station_informationjson).
\-&nbsp;`num_bikes_available` | Yes | Non-negative integer | Number of bikes available for rental.
\-&nbsp;`num_bikes_disabled` | Optional | Non-negative integer | Number of disabled bikes at the station.
\-&nbsp;`num_docks_available` | Yes | Non-negative integer | Number of docks accepting bike returns.
\-&nbsp;`num_docks_disabled` | Optional | Non-negative integer | Number of empty but disabled dock points at the station.
\-&nbsp;`is_installed` | Yes | Boolean | Is the station currently on the street? <br /><br />`1` - Station is installed on the street.<br />`0` - Station is not installed on the street.
\-&nbsp;`is_renting` | Yes | Boolean | Is the station currently renting bikes? <br /><br />`1` - Station is renting bikes.<br /> `0` - Station is not renting bikes.<br /><br /> Even if the station is empty, if it is set to allow rentals this value should be 1.
\-&nbsp;`is_returning` | Yes | Boolean | Is the station accepting bike returns? <br /><br />`1` - Station is accepting bike returns.<br /> `0` - Station is not accepting bike returns.<br /><br /> If a station is full but would allow a return if it was not full, then this value should be 1.
\-&nbsp;`last_reported` | Yes | Timestamp | The last time this station reported its status.
| Field Name | Required | Type | Defines |
|-------------------------------|-------------------------------------------------|----------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| _`stations`_ | Yes | Array | Array that contains one object per station in the system as defined below. |
| \-&nbsp;`station_id` | Yes | ID | Identifier of a station see [station_information.json](#station_informationjson). |
| \-&nbsp;`num_bikes_available` | Yes | Non-negative integer | Number of bikes available for rental. Number of functional bikes physically at the station. To know if the bikes are available for rental, see `is_renting`. |
| \-&nbsp;`num_bikes_disabled` | Optional | Non-negative integer | Number of disabled bikes at the station. *Beta (v2.0-RC):* Vendors who do not want to publicize the number of disabled bikes or docks in their system can opt to omit station capacity (in station_information), `num_bikes_disabled` and `num_docks_disabled`. If station capacity is published then broken docks/bikes can be inferred (though not specifically whether the decreased capacity is a broken bike or dock). |
| \-&nbsp;`num_docks_available` | Yes<br/>*(beta v2.0-RC)* Conditionally required | Non-negative integer | *Current version:* Number of docks accepting bike returns. <br/>*Beta v2.0-RC:* Required except for stations that have unlimited docking capacity (e.g. virtual stations). Number of functional docks physically at the station. To know if the docks are accepting bike returns, see `is_returning`. |
| \-&nbsp;`num_docks_disabled` | Optional | Non-negative integer | Number of empty but disabled dock points at the station. |
| \-&nbsp;`is_installed` | Yes | Boolean | Is the station currently on the street? <br /><br />`1` - Station is installed on the street.<br />`0` - Station is not installed on the street. |
| \-&nbsp;`is_renting` | Yes | Boolean | Is the station currently renting bikes? <br /><br />`1` - Station is renting bikes.<br /> `0` - Station is not renting bikes.<br /><br /> Even if the station is empty, if it is set to allow rentals this value should be 1. |
| \-&nbsp;`is_returning` | Yes | Boolean | Is the station accepting bike returns? <br /><br />`1` - Station is accepting bike returns.<br /> `0` - Station is not accepting bike returns.<br /><br /> If a station is full but would allow a return if it was not full, then this value should be 1. |
| \-&nbsp;`last_reported` | Yes | Timestamp | The last time this station reported its status. |

### free_bike_status.json
Describes bikes that are not at a station and are not currently in the middle of an active ride.
Expand Down

0 comments on commit 643d735

Please sign in to comment.