-
Notifications
You must be signed in to change notification settings - Fork 300
File description: specify endpoint timeout #715
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
base: master
Are you sure you want to change the base?
Conversation
Thank you @AntoineAugusti for raising this important issue 🙏 I've edited your description to reflect that your suggestion is to require a timeout of 5 seconds (MUST) and not to make a recommendation (SHOULD). @AntoineAugusti and community, what is your opinion on these questions:
What do data consumers think (@cmonagle @futuretap @matt-wirtz @tdelmas @testower)? Just as an example: for Google Maps, the latency to retrieve the data is a requirement and the duration is 30 seconds (source). |
If it's a MUST, then it's a breaking change. As a consumer, this change is welcomed. But maybe too strong for the producers and may drive them away from the specification? What about MUST in less than 30s, SHOULD in less than 5s ? And in a future version, reducing those values? |
I'm reopening this issue. It's part of the MobilityData team's to-do list to analyze the current latency of existing GBFS feeds. cc @emmambd |
Our team (MobilityData) has analyzed the latency of the feeds in systems.csv. Thanks @merjakaj for your contribution too! The analysis is based on 1 daily pull of the largest endpoints (
Interpretation:
@AntoineAugusti, @tdelmas, or anyone else, would you like to pursue the proposal to include a maximum latency recommendation (i.e., "HTTP responses SHOULD happen in less than 1 second") in v3.1-RC2, which will be released this month? If so, the vote must be opened this week for adoption before the end of the month. I'd be happy to help with the voting process. Thanks 🙏 |
I have updated the PR with a different wording b071385 |
Thank you to @AntoineAugusti and @tdelmas who contributed to this proposal 🙏 I hereby call a vote on this proposal. Voting will be open for 10 full calendar days until 11:59PM UTC on Friday, May 23. Please vote for or against the proposal, and include the organization for which you are voting in your comment. Governance on the spec change process can be found here. |
+1 from @fluctuo |
+1 from Where To? / FutureTap |
+1 from OpenStreet |
+1 OpenTripPlanner |
This vote has now closed, and it passes! Votes in favor:
There were no votes against.
Thank you all for your involvement in the GBFS spec 🙏 |
EDIT: This change will be included in v3.2-RC scheduled for November 2025. Indeed, the governance states that the voting deadline is April 30th for the MINOR Version Release of May. We apologize for this change. |
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.
Some GBFS feeds respond slowly to HTTP requests, making it difficult for consumers who must increase timeouts or adopt retry strategies.
What is the proposal?
Specify that HTTP responses SHOULD happen in under 1 second. Consumers should be able to set 1 second as a timeout for HTTP requests.
Is this a breaking change?
Which files are affected by this change?
All