fix(client): preserve canonical format options in get_products - #1006
Draft
bokelley wants to merge 1 commit into
Draft
fix(client): preserve canonical format options in get_products#1006bokelley wants to merge 1 commit into
bokelley wants to merge 1 commit into
Conversation
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.
Closes #1005.
What changed
get_productsresponses through the canonicalGetProductsResponsemodel first.format_idsfallback.Root cause
_canonicalize_get_products_result()parsed every response throughLegacyGetProductsResponsebefore projection. The generated legacyProductFormatDeclarationdoes not declareformat_kindorparams, so Pydantic discarded those canonical fields beforeproject_legacy_product()saw them. Valid canonical-only products were then omitted withFORMAT_PROJECTION_FAILEDdiagnostics.Impact
Python buyers using the primary
ADCPClient.get_products()API now retain canonicalformat_options. Legacy-only sellers continue through the compatibility projector.Validation
make test: 6,200 passed, 41 skipped, 1 xfailed; 84.18% coveragemake typecheck-all: passed (932 SDK source files plus strict adopter fixtures)make lint: passedv7.0.0-rc: 2 wire products became 0 with four projection errorsimagedeclarations were preserved