Add JSON-Schema compatibility classification#304
Merged
Conversation
We could validate against and generate JSON Schemas but couldn't classify whether a change is backward / forward / full compatible. Add diff_schemas and check_compatibility over the object subset (properties / required / type / enum): added-required field and narrowed type / removed enum value break backward; removed-required field and widened type / added enum value break forward. Wired through facade, executor (AC_check_compatibility), MCP, and the Script Builder with a headless test batch and EN/Zh docs.
Up to standards ✅🟢 Issues
|
| Metric | Results |
|---|---|
| Complexity | 66 |
| Duplication | 0 |
NEW Get contextual insights on your PRs based on Codacy's metrics, along with PR and Jira context, without leaving GitHub. Enable AI reviewer
TIP This summary will be updated as you push new changes.
|
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
1 participant
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.
What
We could validate against (
json_schema) and generate (action_lint/schema) JSON Schemas but couldn't classify whether a change is backward/forward/full compatible.diff_schemas(old, new)→[SchemaChange(path, kind, breaks)]over the object subset (properties/required/type/enum).check_compatibility(old, new, mode)→{compatible, mode, changes, breaking}.is_backward_compatible/is_forward_compatible/is_full_compatible.Rules (Confluent/Avro): added-required field, narrowed type, removed enum value → break backward; removed-required field, widened type, added enum value → break forward. (Numeric bounds out of scope.)
Layers
utils/schema_compat/(pure stdlib, zero PySide6).__all__.AC_check_compatibility.ac_check_compatibility(read-only).test/unit_test/headless/test_schema_compat_batch.py(10 tests).v96_features_doc.rst(EN + Zh) + toctrees + 3 README What's-new sections.Verification
pytest test/unit_test/headless/test_schema_compat_batch.py→ 10 passed.ruff check je_auto_control/clean; pylint 10.00/10; bandit clean; radon CC clean.