docs: update SPECIFICATION.md for React SPA and new endpoints #26

Closed
opened 2026-02-08 19:50:53 +00:00 by forbes · 0 comments
Owner

Problem

SPECIFICATION.md describes the old htmx/Go-template frontend and is missing recently added API endpoints. This is the most impactful doc to update since it serves as the authoritative system reference.

Supersedes/expands #17.

Specific Issues

Section 2.2 (Technology Stack)

  • Says "Web UI: Go html/template + htmx" — should be React 19, Vite 6, TypeScript 5.7

Section 6 (Web Interface) — Complete rewrite needed

  • Entire section describes htmx templates that no longer exist
  • Section 6.3 says "htmx for interactivity, minimal JavaScript"
  • Should describe: React SPA served at /, Catppuccin Mocha theme, inline styles, component architecture, pages (Items, Projects, Schemas, Settings, Audit, Login)

Section 11.1 (API Endpoints)

  • Still lists removed Web UI routes (GET /, GET /projects, GET /schemas, GET /audit, GET /settings, POST /settings/tokens, POST /settings/tokens/{id}/revoke)
  • Missing new endpoints:
    • GET /api/auth/config
    • POST /api/uploads/presign
    • GET /api/items/{pn}/files
    • POST /api/items/{pn}/files
    • DELETE /api/items/{pn}/files/{fileId}
    • PUT /api/items/{pn}/thumbnail
    • GET /api/items/{pn}/bom/flat
    • GET /api/items/{pn}/bom/cost

Section 12.1 (MVP Implemented)

  • Says "Web UI for items, projects, schemas, audit (htmx)" — wrong

Revision schema (Section 2.2/3.2)

  • Shows property_schema_version column from migration 005 which does not exist on disk

Endpoint count

  • Says "76" in some places — needs reconciliation with actual registered routes

Acceptance Criteria

  • Technology stack table updated for React
  • Section 6 rewritten to describe React SPA architecture
  • All removed web UI routes deleted from Section 11.1
  • All new endpoints added to Section 11.1
  • MVP checklist updated
  • Endpoint count accurate and consistent
## Problem SPECIFICATION.md describes the old htmx/Go-template frontend and is missing recently added API endpoints. This is the most impactful doc to update since it serves as the authoritative system reference. Supersedes/expands #17. ## Specific Issues ### Section 2.2 (Technology Stack) - Says "Web UI: Go html/template + htmx" — should be React 19, Vite 6, TypeScript 5.7 ### Section 6 (Web Interface) — Complete rewrite needed - Entire section describes htmx templates that no longer exist - Section 6.3 says "htmx for interactivity, minimal JavaScript" - Should describe: React SPA served at `/`, Catppuccin Mocha theme, inline styles, component architecture, pages (Items, Projects, Schemas, Settings, Audit, Login) ### Section 11.1 (API Endpoints) - Still lists removed Web UI routes (`GET /`, `GET /projects`, `GET /schemas`, `GET /audit`, `GET /settings`, `POST /settings/tokens`, `POST /settings/tokens/{id}/revoke`) - Missing new endpoints: - `GET /api/auth/config` - `POST /api/uploads/presign` - `GET /api/items/{pn}/files` - `POST /api/items/{pn}/files` - `DELETE /api/items/{pn}/files/{fileId}` - `PUT /api/items/{pn}/thumbnail` - `GET /api/items/{pn}/bom/flat` - `GET /api/items/{pn}/bom/cost` ### Section 12.1 (MVP Implemented) - Says "Web UI for items, projects, schemas, audit (htmx)" — wrong ### Revision schema (Section 2.2/3.2) - Shows `property_schema_version` column from migration 005 which does not exist on disk ### Endpoint count - Says "76" in some places — needs reconciliation with actual registered routes ## Acceptance Criteria - [ ] Technology stack table updated for React - [ ] Section 6 rewritten to describe React SPA architecture - [ ] All removed web UI routes deleted from Section 11.1 - [ ] All new endpoints added to Section 11.1 - [ ] MVP checklist updated - [ ] Endpoint count accurate and consistent
Sign in to join this conversation.
No Label
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: kindred/silo#26