Backend API Catalog¶
API Surface Summary¶
Primary API base path: /api/*
From generated governance artifacts in api-docs-app/src/data/:
- OpenAPI endpoints: 64
- Code-observed endpoints: 264 (
53matched +211code-only) - OpenAPI-only endpoints: 11
This indicates the implementation surface is significantly broader than current OpenAPI coverage.
Resource Class Map (Code)¶
| Resource Class | Base Path |
|---|---|
AttributeResource |
attributes/computed |
CalendarResource |
calendars |
CommandResource |
commands |
ConfigurationResource |
configurations |
DeviceModelResource |
device-model |
DeviceResource |
devices |
DraftsResource |
drafts |
DriverResource |
drivers |
EventResource |
events |
GeofenceResource |
geofences |
GroupResource |
groups |
InventoryResource |
inventories |
JourneyResource |
journey |
MaintenanceResource |
maintenance |
MaintenanceScheduleResource |
maintenance-schedule |
NotificationResource |
notifications |
OrderResource |
orders |
PasswordResource |
password |
PermissionsResource |
permissions |
PositionResource |
positions |
ReportResource |
reports |
RouteResource |
routes |
ServerResource |
server |
SessionResource |
session |
StatisticsResource |
statistics |
TruckAndOwnerResource |
trucks-owners |
TruckOwnerResource |
truck-owners |
UnitResource |
tracking-unit |
UserNotificationSettingResource |
settings/notification |
UserResource |
users |
Major Functional Endpoint Groups¶
Session and authentication¶
GET /session,POST /session,DELETE /sessionGET /session/openid/auth,GET /session/openid/callbackPOST /session/token
Devices and inventory¶
GET/POST/PUT/DELETE /devicesGET/POST/PUT/DELETE /inventories- assignment and authority actions under
/inventories/{id}/... - device configuration and bulk operations under
/devices/...
Journeys and routes¶
POST /journey- journey status views (
/journey/active,/journey/flagged,/journey/completed) - route and corridor management under
/routesand/geofences
Alerts, events, reports¶
- events under
/events - alert-facing report endpoints under
/reports/events,/reports/summary,/reports/trips,/reports/route,/reports/stops
OpenAPI Governance Notes¶
Generated governance indicates:
codeOnlyCount = 211: many implemented paths are not represented in OpenAPIopenApiOnlyCount = 11: some OpenAPI endpoints are not currently matched in code scanning
Recommended maintenance practice:
- Update OpenAPI whenever resource endpoints change
- Re-run API governance generation scripts in
api-docs-app/scripts - Fail CI on large drift if API contract stability is required