Turfi Platform Documentation
Official Turfi documentation portal for users, admins, and developers.
Documentation Search
Search only within Turfi documentation pages.
C
Regions
Region registry contract.
Entity: Regions
1. Overview
- Region registry table retained in the data model, but not exposed as a standalone curated registry in the current admin UI.
- Belongs to an organization.
- Can supply regional context for higher-level governance modeling.
- The
/admin/data/registries/regionsroute redirects to Associations. - There is no standalone curated region grid configuration at present.
2. Database Schema
Columns
| column | type | nullable | default | notes | |
|---|---|---|---|---|---|
| created_at | string \ | null | yes | null | Base table field. |
| id | string | no | generated UUID default | Base table field. | |
| name | string | no | none | Base table field. | |
| organization_id | string \ | null | yes | null | Relationship-bearing column. |
| slug | string \ | null | yes | null | Base table field. |
| status | string | no | database default or generated | Lifecycle field when present. | |
| updated_at | string \ | null | yes | null | Base table field. |
Foreign Keys
| column | references | table | on delete |
|---|---|---|---|
| organization_id | id | organizations | NO ACTION |
Indexes
No migration-defined indexes were discovered in the checked-in SQL history for this table.
Constraints
- Unique: none discovered in checked-in migrations.
- Check: none discovered in checked-in migrations.
Triggers
No migration-defined triggers were discovered in the checked-in SQL history for this table.
Views (if any)
No dedicated registry read view is currently documented for this entity.
3. Import Contract
Accepted Columns
nameorganization_keyorganizationorganization_idslugstatus
Resolution Rules
organization_keyresolves by organization key.- Non-suffixed organization input resolves by
key, thenslug, thenname.
Required Fields
- None documented.
Optional Fields
nameorganization_keyorganizationorganization_idslugstatus
Failure Rules
- Organization mismatches should be resolved before write because the route has no standalone remediation UI.
- Status normalization failures fail normal validation.
4. Frontend Registry Mapping
Grid Columns
No standalone registry grid is currently documented for this entity.
Filters
No standalone registry filters are currently documented for this entity.
Display Logic
- Current frontend behavior redirects to the associations registry, so there is no dedicated region display contract today.
5. Lifecycle Rules
- Region lifecycle should follow organization governance rules if the registry is reactivated.
- Because the UI is redirected, region mutations should be treated as backend/import-only until a curated surface exists.