Skip to content

Commit 7cf2e5c

Browse files
committed
Document get_diagnostic_data breaking change in migration guide
1 parent 2b5fc78 commit 7cf2e5c

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

docs/migration-v2.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -112,6 +112,30 @@ The command execution API has been consolidated into a single method.
112112

113113
v2 also supports sending actions to **multiple devices** in a single call and choosing an `ExecutionMode` (`HIGH_PRIORITY`, `GEOLOCATED`, `INTERNAL`).
114114

115+
## Diagnostics
116+
117+
`get_diagnostic_data()` now returns a structured dict with named sections instead of a flat setup dump.
118+
119+
| v1 | v2 |
120+
|----|-----|
121+
| `data["gateways"]` | `data["setup"]["gateways"]` |
122+
| (not available) | `data["action_groups"]` |
123+
124+
=== "v1"
125+
126+
```python
127+
diagnostics = await client.get_diagnostic_data()
128+
gateways = diagnostics["gateways"]
129+
```
130+
131+
=== "v2"
132+
133+
```python
134+
diagnostics = await client.get_diagnostic_data()
135+
gateways = diagnostics["setup"]["gateways"]
136+
action_groups = diagnostics["action_groups"]
137+
```
138+
115139
## Scenarios → Action groups
116140

117141
| v1 | v2 |

0 commit comments

Comments
 (0)