Commit 49b5f8a
authored
docs: fill gaps in v2 migration guide (#2119)
## Summary
Reviewed the v2 migration guide against the **actual latest v1 release
(`v1.20.6`)** to find breaking changes that were missing. Three genuine
gaps remain after verification; docs-only (`docs/migration-v2.md`).
### Added
- **Iteration over `States` / `CommandDefinitions` /
`StateDefinitions`** — these now subclass `collections.abc.Mapping`, so
`for x in device.states` yields **keys (`str`)** instead of the objects.
Silent change (no exception), and the Home Assistant integration relies
on the old behavior (`sensor.py`, `executor.py`). Added a dedicated
section with a `danger` admonition and `.values()`/`.items()` examples.
- **`Command` is no longer a `dict` subclass** — `command["name"]` no
longer works; use attribute access or `to_payload()`. Notes the new
`type` field and `OverkizCommandParam` parameter support.
- **`Event.setupoid` → `Event.setup_oid`** rename (+ new
`actions`/`owner`/`source` fields), added to the parameter-renames
table.
## Note
My first pass mistakenly diffed against `v1.9.1` (alphabetical tag sort
hid `v1.10`–`v1.20.6`). That produced several false "gaps" —
`verify_ssl`, timestamp `str`→`int`, eight "new" exceptions, two
`Server` enum members, and `APIType` — all of which already shipped in
v1.x. Those were removed in the second commit; everything remaining is
verified against `v1.20.6`.1 parent 7c7d82e commit 49b5f8a
1 file changed
Lines changed: 65 additions & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
112 | 112 | | |
113 | 113 | | |
114 | 114 | | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
115 | 136 | | |
116 | 137 | | |
117 | 138 | | |
| |||
264 | 285 | | |
265 | 286 | | |
266 | 287 | | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
| 311 | + | |
| 312 | + | |
| 313 | + | |
| 314 | + | |
| 315 | + | |
| 316 | + | |
| 317 | + | |
| 318 | + | |
| 319 | + | |
| 320 | + | |
| 321 | + | |
| 322 | + | |
| 323 | + | |
| 324 | + | |
| 325 | + | |
| 326 | + | |
| 327 | + | |
| 328 | + | |
| 329 | + | |
267 | 330 | | |
268 | 331 | | |
269 | 332 | | |
| |||
296 | 359 | | |
297 | 360 | | |
298 | 361 | | |
| 362 | + | |
299 | 363 | | |
300 | | - | |
| 364 | + | |
301 | 365 | | |
302 | 366 | | |
303 | 367 | | |
| |||
0 commit comments