Skip to content

File requirements and Clarifying changes#384

Merged
mplsmitch merged 6 commits into
masterfrom
3.0-breaking-11-1-21
Jan 17, 2022
Merged

File requirements and Clarifying changes#384
mplsmitch merged 6 commits into
masterfrom
3.0-breaking-11-1-21

Conversation

@mplsmitch

@mplsmitch mplsmitch commented Nov 2, 2021

Copy link
Copy Markdown
Contributor

What is the proposal?

This PR contains a number of breaking changes for v3.0 that are needed to correct inconsistencies and further clarify the specification.

Is this a breaking change?

  • Yes
  • No
  • Unsure

Which files are affected by this change?

  • gbfs.md
    • station_information.json
    • free_bike_status.json

Changes SHOULS to MUSTs in File Requirements section, Renames fields describing parking capacity of stations by vehicle type, changes geofencing rules definition  to apply to the intersection of polygons in stead of the union of polygons.
Adds HTTPS reqs to endpoints and deeplinks. Removes system_id from free_bike_status
@mplsmitch mplsmitch added proposal:breaking v3.0-RC Candidate change for GBFS 3.0 (Major release) labels Nov 2, 2021
Updates definition of system_id, SHOULD becomes MUST
@mplsmitch

Copy link
Copy Markdown
Contributor 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.

@richtaylor-ito

Copy link
Copy Markdown
Contributor

+1 from Ito World.

@testower

testower commented Dec 6, 2021

Copy link
Copy Markdown
Contributor

Entur supports this proposal

@nbdh

nbdh commented Dec 6, 2021

Copy link
Copy Markdown
Contributor

+1 from nextbike

One remark on a phrasing detail:

* All files MUST use HTTPS
* All deep links MUST use HTTPS

It is obvious what is meant, but for me it seems that the other points in this list rather describe the content of the files, while the paragraph "File Distribution" rather contains the description of how these files are made available.

Files are distributed as individual HTTP endpoints.

From a technical point of view it also sounds odd that a file uses a protocol.

I suggest to rearrange and/or rephrase these two points.

@heidiguenin

Copy link
Copy Markdown
Contributor

Thanks @nbdh - we'll get that cleaned up before merging!

@kanagy

kanagy commented Dec 6, 2021

Copy link
Copy Markdown

+1 from Google Maps

@heidiguenin

Copy link
Copy Markdown
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
Copy Markdown

+1 from Spin

@heidiguenin

Copy link
Copy Markdown
Contributor

This vote has now closed, and it passes!

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

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

We'll update the documentation as discussed, and then we will tag and merge this into v3.0-RC2 in the coming weeks.

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.

7 participants