docs: update documentation for .kc file integration (Phases 1-4)

- SPECIFICATION.md: add 8 KC endpoints to Section 11.1, new Section 11.3 documenting .kc format, extraction pipeline, packing, lifecycle state machine, and all response shapes. Update endpoint count 78 → 86. - ROADMAP.md: mark .kc Format Spec as Complete in Tier 0 table - STATUS.md: add KC features to core systems table, update migration list through 018, update endpoint count - MODULES.md: add metadata, dependencies, and macros endpoints to core module listing
2026-02-18 19:09:09 -06:00
parent 161c1c1e62
commit bae06da1a1
4 changed files with 918 additions and 6 deletions
--- a/docs/SPECIFICATION.md
+++ b/docs/SPECIFICATION.md
@@ -37,7 +37,7 @@ Silo treats **part numbering schemas as configuration, not code**. Multiple numb
                              ▼
 ┌─────────────────────────────────────────────────────────────┐
 │                   Silo Server (silod)                        │
-│  - REST API (78 endpoints)                                  │
+│  - REST API (86 endpoints)                                  │
 │  - Authentication (local, LDAP, OIDC)                       │
 │  - Schema parsing and validation                            │
 │  - Part number generation engine                            │
@@ -598,7 +598,7 @@ See [AUTH.md](AUTH.md) for full architecture details and [AUTH_USER_GUIDE.md](AU

 ## 11. API Design

-### 11.1 REST Endpoints (78 Implemented)
+### 11.1 REST Endpoints (86 Implemented)

 ```
 # Health (no auth)
@@ -697,6 +697,20 @@ POST   /api/items/{partNumber}/bom/merge                    # Merge BOM from ODS
 PUT    /api/items/{partNumber}/bom/{childPartNumber}        # Update BOM entry [editor]
 DELETE /api/items/{partNumber}/bom/{childPartNumber}        # Remove BOM entry [editor]

+# .kc Metadata (read: viewer, write: editor)
+GET    /api/items/{partNumber}/metadata                     # Get indexed .kc metadata
+PUT    /api/items/{partNumber}/metadata                     # Update metadata fields [editor]
+PATCH  /api/items/{partNumber}/metadata/lifecycle           # Transition lifecycle state [editor]
+PATCH  /api/items/{partNumber}/metadata/tags                # Add/remove tags [editor]
+
+# .kc Dependencies (viewer)
+GET    /api/items/{partNumber}/dependencies                 # List raw dependencies
+GET    /api/items/{partNumber}/dependencies/resolve         # Resolve UUIDs to part numbers + file availability
+
+# .kc Macros (viewer)
+GET    /api/items/{partNumber}/macros                       # List registered macros
+GET    /api/items/{partNumber}/macros/{filename}            # Get macro source content
+
 # Audit (viewer)
 GET    /api/audit/completeness                              # Item completeness scores
 GET    /api/audit/completeness/{partNumber}                 # Item detail breakdown
@@ -735,6 +749,139 @@ POST   /api/inventory/{partNumber}/move

 ---

+## 11.3 .kc File Integration
+
+Silo supports the `.kc` file format — a ZIP archive that is a superset of FreeCAD's `.fcstd`. A `.kc` file contains everything an `.fcstd` does, plus a `silo/` directory with platform metadata.
+
+#### Standard entries (preserved as-is)
+
+`Document.xml`, `GuiDocument.xml`, BREP geometry files (`.brp`), `thumbnails/`
+
+#### Silo entries (`silo/` directory)
+
+| Path | Purpose |
+|------|---------|
+| `silo/manifest.json` | Instance origin, part UUID, revision hash, `.kc` schema version |
+| `silo/metadata.json` | Custom schema field values, tags, lifecycle state |
+| `silo/history.json` | Local revision log (server-generated on checkout) |
+| `silo/dependencies.json` | Assembly link references by Silo UUID |
+| `silo/macros/*.py` | Embedded macro scripts bound to this part |
+
+#### Commit-time extraction
+
+When a `.kc` file is uploaded via `POST /api/items/{partNumber}/file`, the server:
+
+1. Opens the ZIP and scans for `silo/` entries
+2. Parses `silo/manifest.json` and validates the UUID matches the item
+3. Upserts `silo/metadata.json` fields into the `item_metadata` table
+4. Replaces `silo/dependencies.json` entries in the `item_dependencies` table
+5. Replaces `silo/macros/*.py` entries in the `item_macros` table
+6. Broadcasts SSE events: `metadata.updated`, `dependencies.changed`, `macros.changed`
+
+Extraction is best-effort — failures are logged as warnings but do not block the upload.
+
+#### Checkout-time packing
+
+When a `.kc` file is downloaded via `GET /api/items/{partNumber}/file/{revision}`, the server repacks the `silo/` directory with current database state:
+
+- `silo/manifest.json` — current item UUID and metadata freshness
+- `silo/metadata.json` — latest schema fields, tags, lifecycle state
+- `silo/history.json` — last 20 revisions from the database
+- `silo/dependencies.json` — current dependency list from `item_dependencies`
+
+Non-silo ZIP entries are passed through unchanged. If the file is a plain `.fcstd` (no `silo/` directory), it is served as-is.
+
+ETag caching: the server computes an ETag from `revision_number:metadata.updated_at` and returns `304 Not Modified` when the client's `If-None-Match` header matches.
+
+#### Lifecycle state machine
+
+The `lifecycle_state` field in `item_metadata` follows this state machine:
+
+```
+draft → review → released → obsolete
+  ↑        ↓
+  └────────┘
+```
+
+Valid transitions are enforced by `PATCH /metadata/lifecycle`. Invalid transitions return `422 Unprocessable Entity`.
+
+#### Metadata response shape
+
+```json
+{
+  "schema_name": "kindred-rd",
+  "lifecycle_state": "draft",
+  "tags": ["prototype", "v2"],
+  "fields": {"material": "AL6061", "finish": "anodized"},
+  "manifest": {
+    "uuid": "550e8400-e29b-41d4-a716-446655440000",
+    "silo_instance": "silo.example.com",
+    "revision_hash": "abc123",
+    "kc_version": "1.0"
+  },
+  "updated_at": "2026-02-18T12:00:00Z",
+  "updated_by": "forbes"
+}
+```
+
+#### Dependency response shape
+
+```json
+[
+  {
+    "uuid": "550e8400-...",
+    "part_number": "F01-0042",
+    "revision": 3,
+    "quantity": 4.0,
+    "label": "M5 Bolt",
+    "relationship": "component"
+  }
+]
+```
+
+#### Resolved dependency response shape
+
+```json
+[
+  {
+    "uuid": "550e8400-...",
+    "part_number": "F01-0042",
+    "label": "M5 Bolt",
+    "revision": 3,
+    "quantity": 4.0,
+    "resolved": true,
+    "file_available": true
+  }
+]
+```
+
+#### Macro list response shape
+
+```json
+[
+  {"filename": "validate_dims.py", "trigger": "manual", "revision_number": 5}
+]
+```
+
+#### Macro detail response shape
+
+```json
+{
+  "filename": "validate_dims.py",
+  "trigger": "manual",
+  "content": "import FreeCAD\n...",
+  "revision_number": 5
+}
+```
+
+#### Database tables (migration 018)
+
+- `item_metadata` — schema fields, lifecycle state, tags, manifest info
+- `item_dependencies` — parent/child UUID references with quantity and relationship type
+- `item_macros` — filename, trigger type, source content, indexed per item
+
+---
+
 ## 12. MVP Scope

 ### 12.1 Implemented
@@ -743,7 +890,7 @@ POST   /api/inventory/{partNumber}/move
 - [x] YAML schema parser for part numbering
 - [x] Part number generation engine
 - [x] CLI tool (`cmd/silo`)
- [x] API server (`cmd/silod`) with 78 endpoints
+- [x] API server (`cmd/silod`) with 86 endpoints
 - [x] Filesystem-based file storage
 - [x] BOM relationships (component, alternate, reference)
 - [x] Multi-level BOM (recursive expansion with configurable depth)
@@ -765,6 +912,12 @@ POST   /api/inventory/{partNumber}/move
 - [x] Audit logging and completeness scoring
 - [x] CSRF protection (nosurf)
 - [x] Fuzzy search
+- [x] .kc file extraction pipeline (metadata, dependencies, macros indexed on commit)
+- [x] .kc file packing on checkout (manifest, metadata, history, dependencies)
+- [x] .kc metadata API (get, update fields, lifecycle transitions, tags)
+- [x] .kc dependency API (list, resolve with file availability)
+- [x] .kc macro API (list, get source content)
+- [x] ETag caching for .kc file downloads
 - [x] Property schema versioning framework
 - [x] Docker Compose deployment (dev and prod)
 - [x] systemd service and deployment scripts