-
-
Notifications
You must be signed in to change notification settings - Fork 54
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
support rest.exe endpoints #134
Draft
derhuerst
wants to merge
38
commits into
main
Choose a base branch
from
rest-exe
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
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
369e11d
to
5090b99
Compare
829cddb
to
42b2a8a
Compare
(Will rebase to current master and publish a new tag |
derhuerst
commented
Feb 27, 2020
|
1b5fff7
to
fc12560
Compare
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.
rest.exe
HAFAS endpoints have their own URL and require authentication via a token uniquely issued to each customer/user. While they follow the semantics of themgate.exe
endpoints, their responses have entirely different field names and sometimes different nesting levels.Currently, the
mgate.exe
field names are hard-coded into the formatting/parsing code ofhafas-client
(it allows limited customization by overriding formatting/parse functions). We have several ways to support therest.exe
protocol:rest.exe
-specific formatting & parsing functions, some of them re-using themgate.exe
With all three options, one should be able to conveniently specify in an endpoint profile what protocol the endpoint speaks. Also, I should be able to override specific formatting/parsing functions, just like I currently am with
mgate.exe
.I prefer option 2, but it requires significant refactoring work, and I'd also like to merge #132 first, so that we don't accidentally break the
mgate.exe
code. @juliuste What do you think?I went ahead with option 3 in this PR, because it was the most straightforward way to write it step by step. This doesn't mean that we have to keep it this way though! Because we try to avoid breaking changes in
hafas-client
, it seems appropriate to fully cover at least onerest.exe
endpoint before we merge/publish the code.still to do:
cover all features of the APIparse
andparse-rest
? (see above)rest.exe
$TOKEN
to$HAFAS_TOKEN
? (breaking change)