docs: fix schema link and expand storage/ledger reference#16
Merged
Conversation
- Fix broken JSON Schema link in release-artifact.md: release_artifact.schema.json -> release.schema.json (actual file name) - Add pricing_import_audit to the SQLite table list in operations-and-policy.md (7 tables, not 5) - Document Storage connection settings (WAL, IMMEDIATE transactions, busy_timeout, foreign_keys pragma) - Document idempotent run event ingestion: run_id PRIMARY KEY deduplication, per-row insert loop, safe re-ingestion semantics - Document schema migration versions 1-3 with change summary and guidance for adding future migrations - Add Rollup semantics section: how runs/cost/latency/error_rate are computed, run_start vs run_end event counting, latency_ms_avg=None meaning, delta_cost_per_run_pct and delta_latency_ms_avg None guards - Document active_policy single-row upsert behavior and get_active_policy tie-breaking on updated_at Co-authored-by: Gottam Sai Bharath <Gsbreddy@users.noreply.github.com>
Gsbreddy
approved these changes
May 2, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Docs added/updated
docs/release-artifact.mdschemas/v1/release_artifact.schema.json→schemas/v1/release.schema.json(the file that actually exists in the repo; caught by comparing the doc link againstls schemas/v1/).docs/operations-and-policy.mdpricing_import_audittable (7 tables, not 5/6).WAL,IMMEDIATE,busy_timeout=5000,foreign_keys=ON) and whyBEGIN IMMEDIATEis used for promotion and pricing-import transactions.run_idPRIMARY KEY deduplication, safe re-ingest semantics, and what the return value represents.runs,cost_per_run_usd,latency_ms_avg, anderror_rateare computed; clarifiesrun_startvsrun_endevent counting; explainslatency_ms_avg = None(not zero) and the policy skip; documents thedelta_cost_per_run_pctanddelta_latency_ms_avgNoneguards.INSERT … ON CONFLICT DO UPDATEsingle-row semantics andget_active_policytie-breaking byupdated_at.Which codepaths these cover
schemas/v1/release.schema.jsonsrc/flightdeck/storage.py(_configure_connection,transaction)src/flightdeck/storage.py(insert_run_events)src/flightdeck/storage.py(migrate,LATEST_SCHEMA_MIGRATION_VERSION)src/flightdeck/ledger.py(compute_rollup,diff_releases,DiffResult)src/flightdeck/storage.py(set_active_policy,get_active_policy)Key knowledge gaps addressed
pricing_import_auditwas documented in the release-artifact doc but absent from the storage schema table in operations-and-policy.BEGIN IMMEDIATEand WAL pragmas were undocumented; relevant to anyone debuggingSQLITE_BUSYerrors or concurrent access.runs ingestis harmless.run_startevents are counted was not documented; latency/deltaNonevs0distinction was missing.policy_idvalues exist was undocumented.