Commit 1fc037f
authored
docs: Document URL field normalization in typed models (#1005)
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.mdx` gets a "URL fields" section
covering the normalization cases, comparing URLs as `AnyUrl` rather than
raw strings, and building longer URLs with `urljoin`.
- `docs/04_upgrading/upgrading_to_v3.mdx` gets 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*1 parent 37730e8 commit 1fc037f
2 files changed
Lines changed: 65 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
39 | 83 | | |
40 | 84 | | |
41 | 85 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
30 | 30 | | |
31 | 31 | | |
32 | 32 | | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
33 | 54 | | |
34 | 55 | | |
35 | 56 | | |
| |||
0 commit comments