Milestone 2: module/model docs (MD, Sphinx RST, PDF) and work log

74 source modules documented with extracted signatures, JSDoc params,
imports, and call graphs. 10 first-class models (PriceRule through
StatusResponse) have their own MD/RST/PDF. Sphinx HTML builds from
docs/sphinx. Per-module PDFs in docs/modules-pdf and docs/models-pdf.

Middleware gates 2–6 and 10 pass on MOCK_VERAE without NATS.

Learned: RST includes are relative to the RST file; keep one PDF per
module; Add Numbers remains the only push required tomorrow.
This commit is contained in:
George Lambert 2026-09-09 02:44:51 -04:00
parent b814501441
commit 10c663cc0c
347 changed files with 17200 additions and 14 deletions

View file

@ -0,0 +1,27 @@
# StatusResponse
**Kind:** OpenAPI schema
**Defined in:** `docs/00-sources/veraetime-openapi.yaml`
## Fields
| Field | Type | Meaning |
|-------|------|---------|
| `id` | `string` | jobId |
| `status` | `'pending' | 'completed' | 'failed'` | Job state |
| `error` | `string?` | If failed |
| `result` | `string?` | Certificate if completed |
| `completedAt` | `string date-time?` | |
| `metadata` | `object?` | blockIndex, timestamp, certificate, block, chain |
## Who constructs it
HTTP 200 JSON
## Who consumes it
`GET /api/status/{jobId}`, `Find Job Status search`
## Related modules
See `docs/modules/` for the functions that take these types as parameters and the values they return.