📝 docs: account lifecycle endpoints + refreshtoken warning #126

Merged
mat merged 1 commit from docs/account-lifecycle into main 2026-10-11 11:15:47 +00:00
Owner

Summary

Document the account-lifecycle group under ## Users in sites-and-users.md (roadmap §2.4, issue #70):

 sites-and-users.md — ## Users
-  * /api/users and sub-resources (referenced; not exercised)
+### Account lifecycle (/api/users)
+  POST / (register) ; PUT|DELETE /{id} ; PUT /{id}/updateemail
+  POST /{email}/forgottenpasswd ; PUT /{email}/forgottenpasswd/{token}
+  PUT /{email}/token/{token} (activation)
+  GET  /{email}/isReadyForSiteInstallation → 403 END_USER (live)
+⚠ GET /{id}/refreshtoken is NOT a session refresh —
+   re-sends the activation mail (412 user.already.activated, live)

 README.md (docs)
+  index row: account lifecycle
+  error conventions: bare array also with 403 (not authorized)

Closes #70.

Evidence

Live probe 2026-10-11 (END_USER session, reads only):

  • GET /api/users/{id}/refreshtoken → 412, bare array user.already.activated — confirms the canonical conventions example verbatim.
  • GET /api/users/{email}/isReadyForSiteInstallation → 403, bare array not authorized (with arguments/field as null) — a third status code serving the bare-array format (412/404/403), folded into the conventions section.

Write paths (register, reset, activation, update/delete) documented from the 2026-09 re-exploration, not exercised. Real account ids/emails kept out — placeholders only.

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 Document the account-lifecycle group under `## Users` in `sites-and-users.md` (roadmap §2.4, issue #70): ```diff sites-and-users.md — ## Users - * /api/users and sub-resources (referenced; not exercised) +### Account lifecycle (/api/users) + POST / (register) ; PUT|DELETE /{id} ; PUT /{id}/updateemail + POST /{email}/forgottenpasswd ; PUT /{email}/forgottenpasswd/{token} + PUT /{email}/token/{token} (activation) + GET /{email}/isReadyForSiteInstallation → 403 END_USER (live) +⚠ GET /{id}/refreshtoken is NOT a session refresh — + re-sends the activation mail (412 user.already.activated, live) README.md (docs) + index row: account lifecycle + error conventions: bare array also with 403 (not authorized) ``` Closes #70. ## Evidence Live probe 2026-10-11 (END_USER session, reads only): - **`GET /api/users/{id}/refreshtoken`** → `412`, bare array `user.already.activated` — confirms the canonical conventions example verbatim. - **`GET /api/users/{email}/isReadyForSiteInstallation`** → `403`, bare array `not authorized` (with `arguments`/`field` as `null`) — a third status code serving the bare-array format (412/404/403), folded into the conventions section. Write paths (register, reset, activation, update/delete) documented from the 2026-09 re-exploration, not exercised. Real account ids/emails kept out — placeholders only. 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: account lifecycle endpoints + refreshtoken warning
All checks were successful
Tests / forgejo-pytest (pull_request) Successful in 42s
Tests / forgejo-pytest (push) Successful in 42s
1fc7d1997f
mat changed title from WIP: 📝 docs: account lifecycle endpoints + refreshtoken warning to 📝 docs: account lifecycle endpoints + refreshtoken warning 2026-10-11 11:15:44 +00:00
mat merged commit 864a3eb47b into main 2026-10-11 11:15:47 +00:00
mat deleted branch docs/account-lifecycle 2026-10-11 11:15:47 +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!126
No description provided.