api

module
v0.0.0-...-6fb5468 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 29, 2026 License: MIT

Directories

Path Synopsis
cmd
exporter command
Command exporter is the Phase 10 standards-output service: it builds a GTFS.zip per agency on a schedule and serves it, plus a GTFS-RT ServiceAlerts feed (VehiclePositions/TripUpdates continue being served by cmd/server since Phase 8 — see docs/PHASE_PLAN.md Phase 10 for why this isn't consolidated into one binary).
Command exporter is the Phase 10 standards-output service: it builds a GTFS.zip per agency on a schedule and serves it, plus a GTFS-RT ServiceAlerts feed (VehiclePositions/TripUpdates continue being served by cmd/server since Phase 8 — see docs/PHASE_PLAN.md Phase 10 for why this isn't consolidated into one binary).
feedcheck command
Command feedcheck validates a single feed and prints diagnostics.
Command feedcheck validates a single feed and prints diagnostics.
ingestor command
Command ingestor polls configured feeds and persists sync-run audit rows.
Command ingestor polls configured feeds and persists sync-run audit rows.
loadtest command
Command loadtest is a minimal HTTP load generator for Phase 12's "load test: pings ingestion at target fleet scale, GTFS-RT fan-out, portal concurrency; publish results" task.
Command loadtest is a minimal HTTP load generator for Phase 12's "load test: pings ingestion at target fleet scale, GTFS-RT fan-out, portal concurrency; publish results" task.
migrate command
Command migrate applies forward-only SQL migrations to the Transit database.
Command migrate applies forward-only SQL migrations to the Transit database.
server command
Command server is the Transit REST API entrypoint.
Command server is the Transit REST API entrypoint.
tracker command
Command tracker is the Phase 8 background service: it periodically reprocesses every open duty assignment's raw ping trace into authoritative stop_events/vehicle_trips (internal/tracking.ReplayBlock), and separately purges raw pings past the retention window.
Command tracker is the Phase 8 background service: it periodically reprocesses every open duty assignment's raw ping trace into authoritative stop_events/vehicle_trips (internal/tracking.ReplayBlock), and separately purges raw pings past the retention window.
internal
adapters
Package adapters defines the common interface and types for every upstream adapter.
Package adapters defines the common interface and types for every upstream adapter.
adapters/gtfsrt
Package gtfsrt implements the Adapter interface for GTFS realtime feeds.
Package gtfsrt implements the Adapter interface for GTFS realtime feeds.
adapters/gtfsstatic
Package gtfsstatic implements the Adapter interface for GTFS static feeds.
Package gtfsstatic implements the Adapter interface for GTFS static feeds.
adapters/manual
Package manual implements the Adapter interface for agencies with zero prior digital data (brief §5, §9).
Package manual implements the Adapter interface for agencies with zero prior digital data (brief §5, §9).
adapters/osm
Package osm fetches bus-stop candidates from the OpenStreetMap Overpass API for the admin stop-import flow.
Package osm fetches bus-stop candidates from the OpenStreetMap Overpass API for the admin stop-import flow.
dispatch
Package dispatch implements Phase 6 assignment logic: conflict detection, recurring roster expansion, and mid-duty reassignment/handover.
Package dispatch implements Phase 6 assignment logic: conflict detection, recurring roster expansion, and mid-duty reassignment/handover.
exporter
Package exporter builds a standards-compliant GTFS.zip from the canonical tables (brief §5, §9 — "manual" adapter agencies emit their first-ever GTFS feed this way, but every agency's export goes through the same path regardless of adapter).
Package exporter builds a standards-compliant GTFS.zip from the canonical tables (brief §5, §9 — "manual" adapter agencies emit their first-ever GTFS feed this way, but every agency's export goes through the same path regardless of adapter).
generated/oapi
Package oapi provides primitives to interact with the openapi HTTP API.
Package oapi provides primitives to interact with the openapi HTTP API.
gotrue
Package gotrue calls Supabase Auth's (GoTrue) admin API to create and invite driver accounts.
Package gotrue calls Supabase Auth's (GoTrue) admin API to create and invite driver accounts.
httpapi/auth
Package auth provides HTTP middleware that turns an incoming request into an authenticated Actor carrying agency-scoped roles.
Package auth provides HTTP middleware that turns an incoming request into an authenticated Actor carrying agency-scoped roles.
httpapi/handlers
Package handlers contains the HTTP handlers that make up the public API surface.
Package handlers contains the HTTP handlers that make up the public API surface.
httpapi/rbac
Package rbac implements a centralised, table-driven role/permission matrix.
Package rbac implements a centralised, table-driven role/permission matrix.
ingest
Package ingest wires adapters together into a runnable scheduler.
Package ingest wires adapters together into a runnable scheduler.
migrate
Package migrate applies numbered SQL migration files to a Postgres database.
Package migrate applies numbered SQL migration files to a Postgres database.
planner
Package planner implements RAPTOR (Round-based Public Transit Routing) over an in-memory snapshot of one agency's static GTFS timetable, plus walking legs (great-circle distance, no street-network routing engine — see WalkCache's doc comment) and itinerary ranking.
Package planner implements RAPTOR (Round-based Public Transit Routing) over an in-memory snapshot of one agency's static GTFS timetable, plus walking legs (great-circle distance, no street-network routing engine — see WalkCache's doc comment) and itinerary ranking.
store/agencies
Package agencies reads agency metadata from the database.
Package agencies reads agency metadata from the database.
store/apikeys
Package apikeys provides API-key authentication and usage-event recording.
Package apikeys provides API-key authentication and usage-event recording.
store/audit
Package audit writes append-only rows to transit.audit_log.
Package audit writes append-only rows to transit.audit_log.
store/blocks
Package blocks reads and writes GTFS block realisations for a service date.
Package blocks reads and writes GTFS block realisations for a service date.
store/calendar
Package calendar reads and writes GTFS service calendar rows.
Package calendar reads and writes GTFS service calendar rows.
store/depots
Package depots reads and writes depot rows.
Package depots reads and writes depot rows.
store/dispatchmessages
Package dispatchmessages implements dispatcher<->driver messaging.
Package dispatchmessages implements dispatcher<->driver messaging.
store/drivers
Package drivers reads and writes driver profile rows and grants the driver role.
Package drivers reads and writes driver profile rows and grants the driver role.
store/duty
Package duty reads and writes duty assignments and their event log.
Package duty reads and writes duty assignments and their event log.
store/fareproducts
Package fareproducts reads GTFS fare_products rows — used by cmd/exporter; a public fares read path arrives with Phase 11's planner.
Package fareproducts reads GTFS fare_products rows — used by cmd/exporter; a public fares read path arrives with Phase 11's planner.
store/feeds
Package feeds provides database access for feed configuration, sync runs and quarantine rows used by the ingest scheduler.
Package feeds provides database access for feed configuration, sync runs and quarantine rows used by the ingest scheduler.
store/incidents
Package incidents inserts one-tap incident reports from the driver app (Phase 7) and implements the dispatcher-facing intake queue and resolution workflow (Phase 9).
Package incidents inserts one-tap incident reports from the driver app (Phase 7) and implements the dispatcher-facing intake queue and resolution workflow (Phase 9).
store/pings
Package pings inserts raw GPS pings from the driver app and lets internal/tracking (Phase 8) read them back for map-matching and rollup.
Package pings inserts raw GPS pings from the driver app and lets internal/tracking (Phase 8) read them back for map-matching and rollup.
store/routes
Package routes reads route rows from the database.
Package routes reads route rows from the database.
store/servicealerts
Package servicealerts reads and writes admin-authored GTFS-RT service alerts (Phase 11): the /admin authoring queue, the public rider-facing read, and the exporter's GTFS-RT feed all go through this store.
Package servicealerts reads and writes admin-authored GTFS-RT service alerts (Phase 11): the /admin authoring queue, the public rider-facing read, and the exporter's GTFS-RT feed all go through this store.
store/shapes
Package shapes reads GTFS shape points — used only by cmd/exporter; the public API has no shapes endpoint yet (see driver_app's DutyBlockLoader and internal/tracking, which both fall back to straight lines between stops for the same reason).
Package shapes reads GTFS shape points — used only by cmd/exporter; the public API has no shapes endpoint yet (see driver_app's DutyBlockLoader and internal/tracking, which both fall back to straight lines between stops for the same reason).
store/stopevents
Package stopevents writes stop_events rows — the authoritative arrival/departure/delay record computed by internal/tracking.
Package stopevents writes stop_events rows — the authoritative arrival/departure/delay record computed by internal/tracking.
store/stops
Package stops reads stop rows from the database.
Package stops reads stop rows from the database.
store/trips
Package trips reads trip, stop_time and arrival rows from the database.
Package trips reads trip, stop_time and arrival rows from the database.
store/vehicles
Package vehicles reads and writes fleet vehicle rows.
Package vehicles reads and writes fleet vehicle rows.
store/vehicletrips
Package vehicletrips writes vehicle_trips rows — one per GTFS trip actually run within a duty, as determined by internal/tracking.
Package vehicletrips writes vehicle_trips rows — one per GTFS trip actually run within a duty, as determined by internal/tracking.
telemetry
Package telemetry wires OpenTelemetry tracing for every Transit binary (Phase 12 — brief §12 observability).
Package telemetry wires OpenTelemetry tracing for every Transit binary (Phase 12 — brief §12 observability).
testutil
Package testutil provides helpers for Go integration tests against Postgres.
Package testutil provides helpers for Go integration tests against Postgres.
tracking
Package tracking re-runs map-matching and stop detection over the raw vehicle_pings trace server-side, independently of anything the driver app computed on-device (brief §4.2, §9: client results are a hint only — the server's version is authoritative and is what feeds GTFS-RT).
Package tracking re-runs map-matching and stop detection over the raw vehicle_pings trace server-side, independently of anything the driver app computed on-device (brief §4.2, §9: client results are a hint only — the server's version is authoritative and is what feeds GTFS-RT).

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL