Inductions¶
Documentation in progress
This module's documentation will be authored during the relevant sprint. See Phase 1 plan for the sprint mapping.
Purpose¶
Brief description of what this module does and who uses it.
Entities¶
Main entity table¶
| Column | Type | Description |
|---|---|---|
| id | UUID | Primary key |
| ... | ... | ... |
API endpoints¶
| Method | Path | Purpose |
|---|---|---|
| GET | /api/v1/... | List |
| POST | /api/v1/... | Create |
| GET | /api/v1/.../{id} | Read |
| PATCH | /api/v1/.../{id} | Update |
| DELETE | /api/v1/.../{id} | Soft-delete |
Frontend routes¶
/...— list view/.../new— create form/.../:id— detail view
Configurable fields¶
Custom fields supported on this entity:
- text, number, date, boolean, select, multi-select
Permissions¶
| Role | Permissions |
|---|---|
| Tenant Admin | Full CRUD |
| Project Manager | Full CRUD on assigned projects |
| Site Foreman | Create, edit on assigned sites |
| Viewer | Read only |
Offline behaviour¶
What syncs to the client SQLite, and what doesn't.
Known issues / limitations¶
- TBD