API Specification
Owner: Backend
Reviewers: Web, Mobile, QA
Status: Draft
Version: 0.1
Last Updated: 2026-09-16
Review Cycle: Per API contract change
Source Of Truth
Runtime Swagger documentation is served by the backend at /api/docs when the API is running. The backend uses global prefix /api.
Confirmed API Areas
| Area | Status |
|---|---|
| Auth | PARTIAL |
| Users | PARTIAL |
| Farms | PARTIAL |
| Ponds | PARTIAL |
| Crops | PARTIAL |
| Sensors and thresholds | PARTIAL |
| Alerts | PARTIAL |
| Devices | PARTIAL |
| Farming logs | PARTIAL |
| Feeding | PARTIAL/PLANNED |
| Tickets | PARTIAL |
| Notifications | PARTIAL |
| Handbook | PARTIAL |
| Reports | PARTIAL |
| Locations | PARTIAL |
| IoT ingest | PARTIAL |
| Settings | PARTIAL |
| Activity logs | PARTIAL |
| Todo tasks | PARTIAL |
| Dashboard | PARTIAL |
| Health | CONFIRMED |
Contract Rules
- DTOs and Swagger decorators must be updated with API behavior changes.
- Web/mobile clients should call API services rather than hardcoding request logic inside screens.
- Breaking response-shape changes require release notes and regression tests.