onebusaway-application-modules icon indicating copy to clipboard operation
onebusaway-application-modules copied to clipboard

stops-for-route unexpectedly changes behavior based on day

Open AlexKven opened this issue 5 years ago • 1 comments

In version 2.0.39 (PR #240 ), the behavior of stops-for-route was changed to only show stops that a route serves on that particular day. This is an understandable change to avoid confusion for routes that don't serve all stops on weekends, but it causes buggy behavior in consumers of the API, who have come to expect this API to return all stops of a route period.

For example, this is what I get when I use the app on a Sunday (for planning a trip, for example) to look up a weekday-only route: image

I see some value in filtering the stops by day, but I think that should be optional and based on a query parameter, not forced.

AlexKven avatar Feb 17 '20 18:02 AlexKven

I agree this isn't good behavior from a user's perspective.

So I'm starting to remember hearing more discussion generally about this - I think the behavior was changed to avoid showing future service that wasn't in operation yet, although I don't think I realized it would impact the OBA Android app in this way.

@sheldonabrown Does that sound right? Also, does stops-for-routes API in v2 take any dates as parameters?

The REST API docs: http://developer.onebusaway.org/modules/onebusaway-application-modules/current/api/where/methods/stops-for-route.html

...only show id and includePolylines, but I'm not sure if the docs are still from v1.

barbeau avatar Feb 17 '20 18:02 barbeau