feat(output): harmonize canonical schema for 0.4.2 - #112
Merged
Conversation
maebli
marked this pull request as ready for review
August 10, 2026 21:08
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.
Summary
snake_case0.4.2Why
Output surfaces previously relied on a mixture of Rust
Debug/Displayrepresentations and binding-specific record serialization. Units were represented as a nested object with both display and UCUM fields, while standalone Python record decoding returned a different structure from complete-frame decoding. This made equivalent data differ by output format and runtime.Impact
Canonical structured output now uses schema version 2. The
unitfield is a single standardized string when a mapping is available, with a readable fallback otherwise. Legacy compatibility formats and the libmbus-compatible XML vocabulary remain unchanged.Release tags
v0.4.2,cli-v0.4.2,python-v0.4.2, andwasm-v0.4.2will publish the package set. The WASM release also rebuilds and commits the website artifacts underdocs/.Validation
cargo test --workspace --all-featurescargo clippy --all-features -- -D warningscargo fmt --all -- --checkgit diff --check