differential-schema 0.1.0

The frozen JSON contract for differential reading plans
Documentation
  • Coverage
  • 38.1%
    48 out of 126 items documented0 out of 23 items with examples
  • Size
  • Source code size: 24.0 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 1.5 MB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 16s Average build duration of successful builds.
  • all releases: 13s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • thepartly/differential
    13 0 6
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • gogoout

The frozen JSON contract for differential reading plans.

This crate is the product boundary: every consumer (shadow-branch stack, TUI, forge review) depends on these types and nothing else. Consumer conveniences must not leak in here.

Contract rules:

  • schema_version is 1. Readers must reject versions they do not know.
  • Deserialisation tolerates unknown fields, so additive changes are non-breaking.
  • groups/reading_plan are null when the grouping stage has not run. That is distinct from [], which would mean "grouping ran and produced nothing" and is always a bug. generator.stages states exactly which stages produced the document.
  • Optional fields serialise as explicit null, never omitted.