Skip to content

Commit

Permalink
correction: gbfs_versions.json is beta v1.1-RC
Browse files Browse the repository at this point in the history 
fixes the merge of PR #188
addes back section "Files"
  • Loading branch information
@antrim
antrim committed Jan 27, 2020
1 parent 454aafc commit dc99da3
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions gbfs.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -56,19 +56,20 @@ This section defines terms that are used throughout this document.
* Optional - The field may be omitted from the dataset. If an optional column is included, some of the entries in that field may be empty strings. An omitted field is equivalent to a field that is empty.
* Conditionally required - The field or file is required under certain conditions, which are outlined in the field or file description. Outside of these conditions, this field or file is optional.

| File Name | Required | Defines |
|---------------------------|-------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| gbfs.json | Optional<br/>*beta (v2.0-RC):* Yes | Auto-discovery file that links to all of the other files published by the system.<br/>*Current version:* This file is optional, but highly recommended.<br/>*Beta (v2.0-RC):* This file is required. |
| gbfs_versions.json | Optional | Lists all feed endpoints published according to versions of the GBFS documentation. |
| system_information.json | Yes | Describes the system including System operator, System location, year implemented, URLs, contact info, time zone |
| station_information.json | Conditionally required | Mostly static list of all stations, their capacities and locations. Required of systems utilizing docks. |
| station_status.json | Conditionally required | Number of available bikes and docks at each station and station availability. Required of systems utilizing docks. |
| free_bike_status.json | Conditionally required | Bikes that are available for rent. Required of systems that offer bikes for rent outside of stations. |
| system_hours.json | Optional | Hours of operation for the system. |
| system_calendar.json | Optional | Dates of operation for the system. |
| system_regions.json | Optional | Regions the system is broken up into. |
| system_pricing_plans.json | Optional | System pricing scheme. |
| system_alerts.json | Optional | Current system alerts. |
## Files
| File Name | Required | Defines |
|-------------------------------------|------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| gbfs.json | Optional<br/>*beta (v2.0-RC):* Yes | Auto-discovery file that links to all of the other files published by the system.<br/>*Current version:* This file is optional, but highly recommended.<br/>*Beta (v2.0-RC):* This file is required. |
| gbfs_versions.json *(beta v1.1-RC)* | Optional | Lists all feed endpoints published according to versions of the GBFS documentation. |
| system_information.json | Yes | Details including system operator, system location, year implemented, URL, contact info, time zone. |
| station_information.json | Conditionally required | List of all stations, their capacities and locations. Required of systems utilizing docks. |
| station_status.json | Conditionally required | Number of available bikes and docks at each station and station availability. Required of systems utilizing docks. |
| free_bike_status.json | Conditionally required | Bikes that are available for rent. Required of systems that offer bikes for rent outside of stations. |
| system_hours.json | Optional | Hours of operation for the system. |
| system_calendar.json | Optional | Dates of operation for the system. |
| system_regions.json | Optional | Regions the system is broken up into. |
| system_pricing_plans.json | Optional | System pricing scheme. |
| system_alerts.json | Optional | Current system alerts.

## File Requirements
* All files should be valid JSON
Expand Down

0 comments on commit dc99da3

Please sign in to comment.