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

Semantic Changes: Bike becomes Vehicle #354

Merged
merged 10 commits into from
Jan 17, 2022
Merged

Semantic Changes: Bike becomes Vehicle #354

merged 10 commits into from
Jan 17, 2022

Conversation

mplsmitch
Copy link
Collaborator

@mplsmitch mplsmitch commented Aug 19, 2021

What problem does your proposal solve? Please begin with the relevant issue number. If there is no existing issue, please also describe alternative solutions you have considered.

As the specification has evolved to cover multiple vehicles types beyond bicycles, the term "bike" has continued to be used to describe vehicles which may or may not be bikes. This has been a cause of confusion for both publishers and consumers alike.

What is the proposal?

This proposal is a long planned change to remove this ambiguity by replacing the term "bike" with "vehicle' throughout the specification. This requires renaming of an endpoint and several fields including:

  • free_bikes_status.json endpoint becomes vehicle_status.json
  • free_bike_status.bikes[ ] array becomes vehicle_status.vehicles [ ]
  • free_bike_status.bikes[ ].bike_id becomes vehicle_id`
  • station_status.stations[ ].num_bikes_available becomes num_vehicles_available
  • station_status.stations[ ].num_bikes_disabled becomes num_vehicles_disabled

Is this a breaking change?

  • Yes
  • No
  • Unsure

Which files are affected by this change?

gbfs.md
README.md

Mitch Vars added 5 commits August 17, 2021 14:53
Changes language in File Requirements from SHOULD to MUST
Changes use of bike to vehicle in field names and end points. free_bike_status becomes vehicle_status
Removes system_id from vehicle_status endpoint
Change definition of system_id from SHOULD to MUST for each geography
Mitch Vars added 3 commits November 23, 2021 11:48
These changes are covered by a different PR
These changes are handled on another PR
Reverting -This change is handled in a different PR
@mplsmitch
Copy link
Collaborator Author

I hereby call a vote on this proposal. Voting will be open for 10 full calendar days until 11:59PM UTC on December 9, 2021.

Please vote for or against the proposal, and include the organization for which you are voting in your comment.

Please note if you can commit to implementing the proposal.

@kanagy
Copy link

kanagy commented Nov 30, 2021

+1 from Google Maps. Not implementing right now, but will have to support in future as we start to ingest v3.

@richtaylor-ito
Copy link
Contributor

+1 from Ito World.

@sven4all
Copy link
Contributor

+1 from CROW

@cmonagle
Copy link
Contributor

+1 from Transit

@testower
Copy link
Contributor

testower commented Dec 6, 2021

Entur supports this proposal

@nbdh
Copy link
Contributor

nbdh commented Dec 6, 2021

+1 from nextbike

wondering when GBFS is renamed to GVFS 😢

@heidiguenin
Copy link
Contributor

Voting on this PR closes in 2 calendar days. Please vote for or against the proposal, and include the organization for which you are voting in your comment. Please note if you can commit to implementing the proposal.

@ncancelliere
Copy link

+1 from Spin.

@tadam313
Copy link

tadam313 commented Dec 9, 2021

+1 from TIER

@heidiguenin
Copy link
Contributor

This vote has now closed, and it passes!

Votes in favor:
Google Maps (consumer)
Ito World (producer)
CROW (producer)
Transit (consumer)
Entur (consumer)
nextbike (producer)
Spin (producer)
TIER (producer)

There were no votes against.
Thank you to everyone who took the time to review and to vote on this!

We will tag and merge this into v3.0-RC2 in the coming weeks.

@mplsmitch mplsmitch merged commit 4f9fb29 into master Jan 17, 2022
@josee-sabourin josee-sabourin deleted the Vehicles-BP-081721 branch March 13, 2023 14:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
v3.0-RC Candidate change for GBFS 3.0 (Major release) Vote Passed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants