hasadna/open-bus-map-search

stride-api: limit gtfs_ride_stops/list timeframe filtering

Open

#312 opened on Dec 16, 2023

View on GitHub
 (2 comments) (0 reactions) (1 assignee)TypeScript (125 forks)auto 404
backendgood first issue

Repository metrics

Stars
 (95 stars)
PR merge metrics
 (PR metrics pending)

Description

As happened in https://github.com/hasadna/open-bus-stride-api/issues/26 , the gtfs_ride_stops/list api wan unusable without time filtering, because with no limit at all this query is was to heavy.

Add a limit in this API (and maybe open similar tickets to similar APIs that include time filtering) - If no time filters where given, as suggested in https://github.com/hasadna/open-bus-stride-api/issues/26, return an error from the BE, with an indicative msg.

Contributor guide

Research direction
Study the existing time filtering implementation in issue #26 for the gtfs ride stops/list API. Identify where to add a check for missing time filters and return an error response. Implement similar limit logic for this API.
Tech stack
typescript
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitTypeScriptAPI development
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65