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

Follow Hafas' naming for the API version key #9

Open
wants to merge 1 commit into
base: v1
Choose a base branch
from

Conversation

vkrause
Copy link
Member

@vkrause vkrause commented Jan 24, 2021

As per discussion in PR #7.

@vkrause vkrause mentioned this pull request Jan 24, 2021
37 tasks
@derhuerst
Copy link
Member

Technically, this is a breaking change, but AFAIK no one uses transport-apis yet.

@vkrause
Copy link
Member Author

vkrause commented Jan 24, 2021

Technically, this is a breaking change, but AFAIK no one uses transport-apis yet.

Valid point. While it is IMHO still too early to follow strict compatibility rules (we'd need some more content in here first), we probably should make it explicit when we want to start doing that. PR #7 and automatic JSON validation would seem like good prerequisites for that, at least for Hafas endpoints.

@derhuerst derhuerst added the breaking breaking change label Jan 27, 2021
@derf
Copy link
Contributor

derf commented Feb 5, 2021

So you're suggesting we should not just define and validate generic JSON attributes, but also endpoint-specific properties below options, and bump the version when those change?

@derhuerst
Copy link
Member

I think doing this is helpful, if it's not too detailed.

Validation or not, if we renamed version to ver, that would break clients depending on ver. This is why I consider it a breaking change. As @vkrause said though, at this state of the project, that is not relevant yet.

@vkrause
Copy link
Member Author

vkrause commented Feb 6, 2021

Right, this case shows why we would want some validation for this as well. What I tried to do here is fix the current inconsistency between data and documentation regarding options.ver vs. options.version, something that would break client code relying on either one of those variants. As said elsewhere I don't care which variant we agree on, as long as it's consistent everywhere :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking breaking change
Development

Successfully merging this pull request may close these issues.

3 participants