feat!: use type aliases instead of RootModel for root schemas#51
Merged
damaz91 merged 3 commits intoJul 10, 2026
Merged
Conversation
Avoids generating classes with 'root' fields for schemas that don't define an object at the root (like Amount). Instead, they are generated as TypeAliasType using Annotated with Field for validation. This is a breaking change for any client code that was instantiating these root models as classes. TAG=agy CONV=8eec77fa-d0ae-4394-9976-9a7bafa71f51
11 tasks
carolinerg1
approved these changes
Jul 10, 2026
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.
Description
This PR modifies the codegen configuration to avoid generating Pydantic
RootModelclasses for root schemas (schemas that don't define an object at the root, likeAmount). Instead, it generates them as PEP 695TypeAliasTypes combined withAnnotatedfor validation.This resolves the issue where generated Python SDK classes had fields called
root(e.g.,Amount.root).The SDK has been regenerated using UCP schema version
2026-04-08.Type of change
Is this a Breaking Change or Removal?
!to my PR title (e.g.,feat!: remove field).Breaking Changes / Removal Justification
Switching from
RootModelclasses to type aliases is a breaking change because:PaymentHandler(...)is invalid). Clients must use the underlying primitive types directly..rootattribute is no longer available on these types (e.g.,checkout_req.fulfillment.rootwill raiseAttributeError).Downstream conformance tests have been updated in a separate PR to handle this compatibility.
Checklist