-
Notifications
You must be signed in to change notification settings - Fork 103
Maglev 1.0 Endpoint Scope
Maglev 1.0 intentionally implements a bounded set of OneBusAway endpoints. The scope is the OpenAPI-documented OBA API plus explicitly approved Maglev extensions and GTFS Realtime protobuf feeds.
Maglev 1.0 is not intended to reproduce every endpoint that exists in the legacy Java OneBusAway server.
- If an endpoint is not listed on this page, do not implement it for Maglev 1.0 just because it exists in the legacy server.
- The legacy server contains undocumented, experimental, or internal endpoints. Those endpoints are out of scope by default.
- New endpoints require an explicit scope decision and should be documented/speced before implementation.
/api/where/agencies-with-coverage.json/api/where/agency/{id}.json
/api/where/route/{id}.json/api/where/route-ids-for-agency/{id}.json/api/where/routes-for-agency/{id}.json/api/where/routes-for-location.json
/api/where/stop/{id}.json/api/where/stop-ids-for-agency/{id}.json/api/where/stops-for-agency/{id}.json/api/where/stops-for-location.json/api/where/stops-for-route/{id}.json
/api/where/arrival-and-departure-for-stop/{id}.json/api/where/arrivals-and-departures-for-location.json/api/where/arrivals-and-departures-for-stop/{id}.json/api/where/schedule-for-route/{id}.json/api/where/schedule-for-stop/{id}.json/api/where/trip-for-vehicle/{id}.json
/api/where/trip/{id}.json/api/where/trip-details/{id}.json/api/where/trips-for-location.json/api/where/trips-for-route/{id}.json
/api/where/vehicles-for-agency/{id}.json
/api/where/search/route.json/api/where/search/stop.json
/api/where/config.json/api/where/current-time.json/api/where/shape/{id}.json
These endpoints are in scope for compatibility with existing apps, but the problem-reporting feature is deprecated. Do not expand this API; it is an immediate candidate for replacement by a future v2 API.
/api/where/report-problem-with-stop/{id}.json/api/where/report-problem-with-trip/{id}.json
These endpoints are intentionally added by Maglev and are in scope for 1.0:
-
/api/where/problem-reports-for-stop/{id}.json— deprecated problem-reporting feature -
/api/where/problem-reports-for-trip/{id}.json— deprecated problem-reporting feature /api/v2/metadata.json
These are separate from the OBA REST JSON API but are in scope for Maglev 1.0:
/api/gtfs_realtime/vehicle-positions-for-agency/{id}.pb/api/gtfs_realtime/alerts-for-agency/{id}.pb/api/gtfs_realtime/trip-updates-for-agency/{id}.pb
Any legacy Java endpoint not listed above is out of scope for Maglev 1.0 unless a later scope decision explicitly adds it. This includes undocumented legacy endpoints discovered by code inspection.