📝 docs: bare-array errors not 412-only (404 + field key) #125

Merged
mat merged 1 commit from docs/404-bare-array into main 2026-10-11 11:12:36 +00:00
Owner

Summary

Amend the error conventions after the Modbus live probe (follow-up to #123, evidence gathered for #69):

 docs/energy.comwatt.com/README.md — error conventions
-  second error format: HTTP 412 + bare JSON array
+  second error format: bare JSON array — first seen with 412,
+  not tied to it (404 + array on Modbus-only endpoints)
-  Observed on refreshtoken / network / installation-company-by-installer-email
+  with 412 on those; with 404 on modbus-expert / state-history
+  code not always symbolic (full message), extra `field` key
 Typical codes observed / 404 bullet
+  also served with the bare-array body (Modbus-only endpoints)

Evidence

Live probe 2026-10-11: GET /api/connectedobjects/{id}/modbus-expert and state-history on a non-Modbus object → 404, content-type: application/json, body = bare Spring array with field key and the full message in code ("No Modbus configuration associated with ConnectedObject id: {id}").

Links to devices.md#modbus-group (PR #124) — if this merges first the anchor dangles harmlessly until #124 lands.

Docs-only change, no code touched. Test suite: 139 passed (unchanged baseline).

Merge Danger

Door: two-way (docs-only, trivially revertible)

Blast Radius: none — documentation only.

## Summary Amend the error conventions after the Modbus live probe (follow-up to #123, evidence gathered for #69): ```diff docs/energy.comwatt.com/README.md — error conventions - second error format: HTTP 412 + bare JSON array + second error format: bare JSON array — first seen with 412, + not tied to it (404 + array on Modbus-only endpoints) - Observed on refreshtoken / network / installation-company-by-installer-email + with 412 on those; with 404 on modbus-expert / state-history + code not always symbolic (full message), extra `field` key Typical codes observed / 404 bullet + also served with the bare-array body (Modbus-only endpoints) ``` ## Evidence Live probe 2026-10-11: `GET /api/connectedobjects/{id}/modbus-expert` and `state-history` on a non-Modbus object → `404`, `content-type: application/json`, body = bare Spring array with `field` key and the full message in `code` (`"No Modbus configuration associated with ConnectedObject id: {id}"`). Links to `devices.md#modbus-group` (PR #124) — if this merges first the anchor dangles harmlessly until #124 lands. Docs-only change, no code touched. Test suite: 139 passed (unchanged baseline). ## Merge Danger **Door:** two-way (docs-only, trivially revertible) **Blast Radius:** none — documentation only.
📝 docs: bare-array errors not 412-only (404 + field key)
All checks were successful
Tests / forgejo-pytest (pull_request) Successful in 41s
Tests / forgejo-pytest (push) Successful in 42s
a8c9378fb6
mat changed title from WIP: 📝 docs: bare-array errors not 412-only (404 + field key) to 📝 docs: bare-array errors not 412-only (404 + field key) 2026-10-11 11:12:27 +00:00
mat merged commit 47f43fc19e into main 2026-10-11 11:12:36 +00:00
mat deleted branch docs/404-bare-array 2026-10-11 11:12:37 +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!125
No description provided.