marchon/master-zapier-plan-draft
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1

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

Browse source 
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
Download patch file Download diff file Expand all files Collapse all files

16
docs/models/README.md Normal file
View file

@ -0,0 +1,16 @@
# Data models
Each model has its own MD, Sphinx RST, and PDF under `docs/models/` and `docs/models-pdf/`.
| Model | Defined in | Role |
|-------|------------|------|
| [PriceRule](PriceRule.md) | `packages/zappier/src/pricing.ts` | free / fixed / variable list price |
| [TierConfig](TierConfig.md) | `pricing.ts` | multiplier + monthly credit |
| [RateCard](RateCard.md) | `pricing.ts` | map of operationId → PriceRule |
| [Quote](Quote.md) | `pricing.ts` | listCents, totalCents, breakdown |
| [CallUsage](CallUsage.md) | `pricing.ts` | metadataBytes, attachmentBytes |
| [Customer](Customer.md) | `packages/zappier/src/auth.ts` | id, tierId, apiKey |
| [AddNumbersResult](AddNumbersResult.md) | `packages/verae-activate/creates/add_numbers.js` | number1, number2, sum, mode |
| [TimestampRequest](TimestampRequest.md) | Verae OpenAPI | data, hashAlg |
| [TimestampResponse](TimestampResponse.md) | Verae OpenAPI | jobId |
| [StatusResponse](StatusResponse.md) | Verae OpenAPI | id, status, result, metadata |