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

otpGraphQL: remove supportedTransitModes field #65

Open
1Maxnet1 opened this issue Feb 22, 2023 · 2 comments
Open

otpGraphQL: remove supportedTransitModes field #65

1Maxnet1 opened this issue Feb 22, 2023 · 2 comments
Labels
breaking breaking change

Comments

@1Maxnet1
Copy link
Collaborator

I found that in

"supportedTransitModes": [ "TRANSIT", "CARPOOL" ]
and
"supportedTransitModes": [ "TRANSIT", "CARPOOL" ]
an option called "supportedTransitModes" is used. However it is not mentioned in the protocol specific options: https://github.com/public-transport/transport-apis#open-trip-planner-with-graphql

So imho it would make sense to add it there and maybe link to the possible values (e.g. this https://docs.opentripplanner.org/en/dev-2.x/RoutingModes/ if I'm not mistaken).

If you agree I could make a little PR adding the documentation

@1Maxnet1
Copy link
Collaborator Author

Actually I would say, that the supportedTransitModes can be retrieved from the api (named travelOptions see e.g. https://api.stadtnavi.de/routing/v1/router/ and http://dev.opentripplanner.org/apidoc/1.0.0/json_TravelOption.html) so we do not need to have them in the configuration file at all. As removing them would be a breaking change, I would suggest to document the option anyway and mention that they can be retrieved from the api, so the option shouldn't be used, so that it can be removed in a new major release of this repo?

However I would appreciate some thoughts on that :)

@derhuerst
Copy link
Member

I agree that it can be removed as a breaking change.

@derhuerst derhuerst added the breaking breaking change label Mar 2, 2023
@derhuerst derhuerst changed the title otpGraphQL: supportedTransitModes not documented otpGraphQL: remove supportedTransitModes field Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
breaking breaking change
Development

No branches or pull requests

2 participants