Best practice regarding URLs and version upgrades #699
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
isabelle-dr
approved these changes
Oct 23, 2024
There was a problem hiding this comment.
LGTM.
Regarding not including the minor version in the URL; I see many feeds that don't follow this in systems.csv.
Should we do the following:
- contact them to let them know if this new Best Practice
- add this to the validator (acknowledging this might be a bit of a clunky validation)
|
Good point. 10% of the feeds in systems.csv include the MINOR version number in their URL. I added both strategies to the MobilityData product backlog. Thanks @isabelle-dr 🙏 |
|
@richfab |
|
I added this idea to the MobilityData product backlog as well. Good point! Thanks |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes #655
What problem does your proposal solve?
When a GBFS producer upgrades their feed to a MAJOR version without changing the feed URL, it can break consuming applications.
What is the proposal?
Add a best practice in the spec to recommend that feed URLs contain the MAJOR version number. eg: https://www.example.com/gbfs/v3/gbfs.json
Is this a breaking change?
Which files are affected by this change?
It does not affect the content of the files, only the URL of the files.
Thank you @AntoineAugusti for raising this issue 🙏