endpoints

Documentation

Overview

Package endpoints contains the logic for each public API endpoint.

Index

• func Entrypoint(ctx context.Context, r *Context, req *api.EntrypointRequest) (*api.EntrypointReply, error)
• func GetAgency(ctx context.Context, r *Context, req *api.GetAgencyRequest) (*api.Agency, error)
• func GetAlert(ctx context.Context, r *Context, req *api.GetAlertRequest) (*api.Alert, error)
• func GetFeed(ctx context.Context, r *Context, req *api.GetFeedRequest) (*api.Feed, error)
• func GetRoute(ctx context.Context, r *Context, req *api.GetRouteRequest) (*api.Route, error)
• func GetShape(ctx context.Context, r *Context, req *api.GetShapeRequest) (*api.Shape, error)
• func GetStop(ctx context.Context, r *Context, req *api.GetStopRequest) (*api.Stop, error)
• func GetSystem(ctx context.Context, r *Context, req *api.GetSystemRequest) (*api.System, error)
• func GetTrip(ctx context.Context, r *Context, req *api.GetTripRequest) (*api.Trip, error)
• func GetVehicle(ctx context.Context, r *Context, req *api.GetVehicleRequest) (*api.Vehicle, error)
• func ListAgencies(ctx context.Context, r *Context, req *api.ListAgenciesRequest) (*api.ListAgenciesReply, error)
• func ListAlerts(ctx context.Context, r *Context, req *api.ListAlertsRequest) (*api.ListAlertsReply, error)
• func ListFeeds(ctx context.Context, r *Context, req *api.ListFeedsRequest) (*api.ListFeedsReply, error)
• func ListRoutes(ctx context.Context, r *Context, req *api.ListRoutesRequest) (*api.ListRoutesReply, error)
• func ListShapes(ctx context.Context, r *Context, req *api.ListShapesRequest) (*api.ListShapesReply, error)
• func ListStops(ctx context.Context, r *Context, req *api.ListStopsRequest) (*api.ListStopsReply, error)
• func ListSystems(ctx context.Context, r *Context, req *api.ListSystemsRequest) (*api.ListSystemsReply, error)
• func ListTransfers(ctx context.Context, r *Context, req *api.ListTransfersRequest) (*api.ListTransfersReply, error)
• func ListTrips(ctx context.Context, r *Context, req *api.ListTripsRequest) (*api.ListTripsReply, error)
• func ListVehicles(ctx context.Context, r *Context, req *api.ListVehiclesRequest) (*api.ListVehiclesReply, error)
• type Context
• type EndpointOptions

Functions

func Entrypoint

func Entrypoint(ctx context.Context, r *Context, req *api.EntrypointRequest) (*api.EntrypointReply, error)

func GetAgency

func GetAgency(ctx context.Context, r *Context, req *api.GetAgencyRequest) (*api.Agency, error)

func GetAlert

func GetAlert(ctx context.Context, r *Context, req *api.GetAlertRequest) (*api.Alert, error)

func GetFeed

func GetFeed(ctx context.Context, r *Context, req *api.GetFeedRequest) (*api.Feed, error)

func GetRoute

func GetRoute(ctx context.Context, r *Context, req *api.GetRouteRequest) (*api.Route, error)

func GetShape

func GetShape(ctx context.Context, r *Context, req *api.GetShapeRequest) (*api.Shape, error)

func GetStop

func GetStop(ctx context.Context, r *Context, req *api.GetStopRequest) (*api.Stop, error)

func GetSystem

func GetSystem(ctx context.Context, r *Context, req *api.GetSystemRequest) (*api.System, error)

func GetTrip

func GetTrip(ctx context.Context, r *Context, req *api.GetTripRequest) (*api.Trip, error)

func GetVehicle

func GetVehicle(ctx context.Context, r *Context, req *api.GetVehicleRequest) (*api.Vehicle, error)

func ListAgencies

func ListAgencies(ctx context.Context, r *Context, req *api.ListAgenciesRequest) (*api.ListAgenciesReply, error)

func ListAlerts

func ListAlerts(ctx context.Context, r *Context, req *api.ListAlertsRequest) (*api.ListAlertsReply, error)

func ListFeeds

func ListFeeds(ctx context.Context, r *Context, req *api.ListFeedsRequest) (*api.ListFeedsReply, error)

func ListRoutes

func ListRoutes(ctx context.Context, r *Context, req *api.ListRoutesRequest) (*api.ListRoutesReply, error)

func ListShapes

func ListShapes(ctx context.Context, r *Context, req *api.ListShapesRequest) (*api.ListShapesReply, error)

func ListStops

func ListStops(ctx context.Context, r *Context, req *api.ListStopsRequest) (*api.ListStopsReply, error)

func ListSystems

func ListSystems(ctx context.Context, r *Context, req *api.ListSystemsRequest) (*api.ListSystemsReply, error)

func ListTransfers

func ListTransfers(ctx context.Context, r *Context, req *api.ListTransfersRequest) (*api.ListTransfersReply, error)

func ListTrips

func ListTrips(ctx context.Context, r *Context, req *api.ListTripsRequest) (*api.ListTripsReply, error)

func ListVehicles

func ListVehicles(ctx context.Context, r *Context, req *api.ListVehiclesRequest) (*api.ListVehiclesReply, error)

Types

type Context

type Context struct {
	Querier         db.Querier
	Reference       reference.Generator
	Logger          *slog.Logger
	EndpointOptions EndpointOptions
}

type EndpointOptions

type EndpointOptions struct {
	// The maximum number of stops, vehicles, and shapes that can be returned in a single request.
	// Defaults to 100.
	MaxEntitiesPerRequest int32
}