📝 docs: get_connected_object_devices live shape (docstring, README, test payloads) #156

Merged
mat merged 1 commit from docs/co-devices-live-shape into main 2026-10-27 10:02:45 +00:00
Owner

Summary

 get_connected_object_devices docstring/README/tests
-  "payload shape not captured in the field notes"
+  observed shape from the 2026-10-27 live probe (full device documents)

The live probe run after #155 surfaced the actual payload: full device documents (JSON-with-refs family) with id, name, uuid, deviceKind, capacities, features, site, coState, configuration, partNature, threePhase, archived, children, sourceIsOnline, @id. The docstring, README line, and mocked test payloads now reflect it instead of hedging.

Evidence

  • Before: docstring claimed the shape was unknown; mocked payloads were 2-key skeletons.
  • After: docstring + README carry the observed keys and the 2026-10-27 verification date; test payloads use realistic observed fields; pytest = 185 passed, mypy clean.

Merge Danger

Door: two-way — comments, docs and test fixtures only; no behavior change.

Blast Radius: none beyond the method's documentation and its own test fixtures.

## Summary ```diff get_connected_object_devices docstring/README/tests - "payload shape not captured in the field notes" + observed shape from the 2026-10-27 live probe (full device documents) ``` The live probe run after #155 surfaced the actual payload: full device documents (JSON-with-refs family) with `id, name, uuid, deviceKind, capacities, features, site, coState, configuration, partNature, threePhase, archived, children, sourceIsOnline, @id`. The docstring, README line, and mocked test payloads now reflect it instead of hedging. ## Evidence - **Before:** docstring claimed the shape was unknown; mocked payloads were 2-key skeletons. - **After:** docstring + README carry the observed keys and the 2026-10-27 verification date; test payloads use realistic observed fields; `pytest` = **185 passed**, `mypy` clean. ## Merge Danger **Door:** two-way — comments, docs and test fixtures only; no behavior change. **Blast Radius:** none beyond the method's documentation and its own test fixtures.
📝 docs: get_connected_object_devices live shape (docstring, README, test payloads)
Some checks failed
Tests / forgejo-pytest (pull_request) Successful in 43s
Tests / forgejo-pytest (push) Has been cancelled
9b79d93e50
mat force-pushed docs/co-devices-live-shape from 9b79d93e50
Some checks failed
Tests / forgejo-pytest (pull_request) Successful in 43s
Tests / forgejo-pytest (push) Has been cancelled
to e3390a78ad
All checks were successful
Tests / forgejo-pytest (push) Successful in 42s
Tests / forgejo-pytest (pull_request) Successful in 43s
2026-10-27 10:01:46 +00:00
Compare
mat changed title from WIP: 📝 docs: get_connected_object_devices live shape (docstring, README, test payloads) to 📝 docs: get_connected_object_devices live shape (docstring, README, test payloads) 2026-10-27 10:02:40 +00:00
mat merged commit 98b862d303 into main 2026-10-27 10:02:45 +00:00
mat deleted branch docs/co-devices-live-shape 2026-10-27 10:02:45 +00:00
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
mat/python-comwatt-client!156
No description provided.