datagovsg / beeline-server Goto Github PK

The mobile app and admin panel currently requires all routes to be returned at /routes and friends. The former leads to significant capacity problems, which in-process caching has not been able to redress completely.

/routes should hence support page parameters to limit what is brought in. These parameters should be optional so that we can introduce pagination gradually. Support for text search must also be considered, since the mobile app requires this but currently performs full-text search on the entire population that it gets from /routes

The readme talks about updating the config.js. However, I was unable to locate the same. Going by the previous commits, it seems that the config.js was removed during the commit dated 8 Jan 2019. Would it be possible to modify the ReadMe accordingly. Thanks

As of now, Swagger doesn't easily describe which endpoints are meant for the commuter app, and which are for admin purposes. This makes it cumbersome for external parties and others in future to work out which endpoints matter when building things out.

Tag all the endpoints in Swagger as commuter, admin, or both the tags. They can then be filtered by specifying the tag, eg, https://api.beeline.sg/?tags=commuter.

Commuter endpoints are easily identified by looking at beeline-frontend and the requests it makes

Given that we are largely dependent on other mapping services, it makes sense to use these same services to back our reverse geocoding endpoints

/transaction_items/route_passes allows programmatic access to transactions relating to route passes, but csv dumps are needed for human consumption. Provide an equivalent endpoint for this, studying /transaction_items to see how csv dumps are handled there

Route passes are meant to have an expiry date per the standard terms and conditions we give to all companies, but this is not strictly enforced. This now has to be done so that financial reporting remains manageable.

Add a new expiresAt column to the route pass, and ensure that this is populated when a route pass is created. Modify the job that expires route passes to inspect this new field.

As noted - use OneSignal to send a push notification to users when their route passes are near expiry.

This supersedes datagovsg/beeline-admin#305