Problem
#21 adds JSON export for CleanReport. Consumers integrating the audit trail into pipelines also need a stable schema to validate that JSON against, so downstream tooling can rely on the shape.
Follows #21 (the JSON export). Best done once the export format is settled.
Expected outcome
A published JSON Schema for the report payload, plus a small helper (e.g. report.to_json_schema() or a shipped schemas/clean_report.schema.json).
Relevant files
src/freshdata/report.py (or a new schemas/ file)
- docs (audit-trail page)
tests/ (validate real report.to_dict() output against the schema)
Acceptance criteria
Difficulty / skills
🚀 mid — typing, JSON Schema (jsonschema is already a dev dep).
Problem
#21 adds JSON export for
CleanReport. Consumers integrating the audit trail into pipelines also need a stable schema to validate that JSON against, so downstream tooling can rely on the shape.Expected outcome
A published JSON Schema for the report payload, plus a small helper (e.g.
report.to_json_schema()or a shippedschemas/clean_report.schema.json).Relevant files
src/freshdata/report.py(or a newschemas/file)tests/(validate realreport.to_dict()output against the schema)Acceptance criteria
report.to_dict()/ JSON-export output.Difficulty / skills
🚀 mid — typing, JSON Schema (
jsonschemais already a dev dep).