Skip to main content

CONTRACT_COMPATIBILITY_MARKDOWN

Constant CONTRACT_COMPATIBILITY_MARKDOWN 

Source
pub const CONTRACT_COMPATIBILITY_MARKDOWN: &str = "# Contract compatibility\n\nThe public compatibility categories are `safe`, `needs_attention`, `breaking`, and `blocked`.\nEvery result identifies its contract kind, changed version, affected references, stable reason\ncodes, JSON paths, and next actions. Provider Protocol, Service Contract, Event Contract, Config\nContract, and Reliability Contract are distinct machine-readable kinds.\n\nEvent comparison is independent of broker choice and evaluates canonical JSON Schema or Protobuf\nbusiness-event shapes. Generated Event Contract comparison additionally covers protocol, stable\nProducer and Module identity, Tenancy Mode, required common context, Operating Regions, and the\nembedded authoritative payload schema. Config comparison covers required values, sensitivity,\nscope, mutability, and activation requirements. Reliability comparison is conservative:\ndeclaration changes require review and never claim that Lenso enforces availability, latency,\nhealth, backlog, error-budget, or rollout expectations at runtime.\n\nThe Event, Config, and Reliability golden pairs under `fixtures/compatibility` are authoritative\ndeterministic examples. Their exact sorted machine results are generated into\n`contracts/compatibility/contract-compatibility.v1.json` and freshness-checked by `arch-check`.\n";