docs: Document URL field normalization in typed models - #1005
Merged
Conversation
vdusek
added
the
t-tooling
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1005 +/- ##
==========================================
- Coverage 94.86% 94.84% -0.02%
==========================================
Files 58 58
Lines 5357 5357
==========================================
- Hits 5082 5081 -1
- Misses 275 276 +1
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Pijukatel
approved these changes
Aug 12, 2026
Pijukatel
left a comment
Pijukatel
left a comment
Contributor
There was a problem hiding this comment.
Nice with all the examples
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
3 participants
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.
URL fields on the returned models are
pydantic.AnyUrl, which normalizes the value during validation, so the string read back can differ from the one the API sent. The trailing slash is the most visible case; normalization also lowercases the host, drops default ports, punycodes internationalized hosts, and percent-encodes unsafe characters. The behavior is intended, it just wasn't documented.docs/02_concepts/12_typed_models.mdxgets a "URL fields" section covering the normalization cases, comparing URLs asAnyUrlrather than raw strings, and building longer URLs withurljoin.docs/04_upgrading/upgrading_to_v3.mdxgets a "URL fields are normalized" section framing it as the v2 to v3 change, with the affected field names.Closes #999
✍️ Drafted by Claude Code