Skip to content

Documentation Review (2026-05-27): behaviors.md missing significant API endpoints #268

@evan-zhang11

Description

@evan-zhang11

Summary

Daily documentation review identified multiple implemented API endpoints that are completely missing from docs/dev/behaviors.md. The documentation has fallen significantly behind the codebase.

Missing API Endpoints in behaviors.md

🔴 High Priority — Entire feature areas undocumented

Endpoint(s) Handler(s) Description
GET/POST/PUT/DELETE /api/maps, /api/maps/:id map_handlers Map editor feature — completely undocumented
GET /api/maps/preview-sources list_preview_sources Preview source listing for maps
GET /api/maps/preview-sources/:sourceId/field-values get_field_values Field value lookup for map styling
GET/POST /api/icons, PATCH/DELETE /api/icons/:id, GET /api/icons/:id/file icon_handlers Icon management — completely undocumented
DELETE /api/fonts/:id delete_font Font deletion endpoint missing from API-020

🟡 Medium Priority — Individual endpoints

Endpoint Handler Description
PATCH /api/files/:id/zoom update_tile_zoom Update tile zoom settings — undocumented
GET /api/workspaces/current get_current_workspace Get current workspace — undocumented
GET /api/workspaces/:id get_workspace Get single workspace — undocumented
POST /api/workspaces/:id/leave leave_workspace Leave workspace — undocumented
POST /api/postgis/connections/connect connect_postgis PostGIS connection save — undocumented
POST /api/postgis/connections/discover-schemas discover_schemas PostGIS schema discovery — undocumented
POST /api/postgis/connections/discover-tables discover_tables PostGIS table discovery — undocumented
POST /api/postgis/connections/discover-columns discover_columns PostGIS column discovery — undocumented
POST /api/postgis/connections/discover-objects discover_objects PostGIS object discovery — undocumented

Discrepancies in Existing Entries

  1. API-018 (PostGIS connection test): Doc says POST /api/postgis/connections/test — ✅ correct, but the actual implementation also has connect_postgis at /connections/connect which is a separate endpoint not mentioned.

  2. API-019 (PostGIS source register): The register flow now has supporting discovery endpoints (discover-schemas/tables/columns/objects) that form part of the registration UX but aren't documented.

  3. WS-002 (workspace list): Documentation says GET /api/workspaces returns workspaces, but doesn't mention GET /api/workspaces/current for the active workspace or GET /api/workspaces/:id for individual workspace details.

Recommendations

  1. Add new sections for Maps API and Icons API with full behavioral contracts
  2. Add individual entries for the missing endpoints listed above
  3. Update existing entries (API-020, API-018/019, WS-002) to reference related endpoints
  4. Consider a CI check that extracts routes from routes.rs and cross-references with behaviors.md to catch future drift

Impact

  • New contributors cannot understand the full API surface from documentation
  • Testing coverage appears incomplete because undocumented endpoints have no behavioral contracts
  • The map editor feature (recently merged) has zero documentation coverage

Auto-generated by daily documentation review (Evan 🦀)

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions