Skip to content

docs(architecture): list reset-password in the auth endpoint roster - #421

Merged
argszero merged 1 commit into
mainfrom
docs/auth-roster-reset-password
Oct 19, 2026
Merged

argszero merged 1 commit into
mainfrom
docs/auth-roster-reset-password

Conversation

@argszero

Copy link
Copy Markdown
Owner

Summary

Section 6 of docs/architecture.md groups the auth routes under their shared
POST /api/auth/ prefix and named six of the seven. The missing one is
reset-password, and it is the half that makes password recovery work at all.

Route In the roster before What it needs
forgot-password yes nothing — mails a code
reset-password no email + that code + new password
change-password yes a Bearer session and the old password

So the roster described a flow that stops one step short: a reader could see
how to request a code and had no listed route to submit it. The only password
route named at that point requires being logged in and remembering the current
password — precisely what someone who has forgotten theirs does not have. The
shipped UI already calls /api/auth/reset-password
(ui/js/app.js:4220), so this was documentation lagging the product, not a
dead endpoint.

Changes

  • docs/architecture.md:82 — reset-password added to the auth roster,
    placed directly after forgot-password so the send-code and submit-code
    pair reads adjacently
  • One entry added and nothing else: the section preamble says the table is
    a functional overview, not a per-route inventory, so the fix closes the
    recovery face without turning the table into something it disclaims
  • No other carrier needed the same edit — ui/README.md:899 already names
    reset-password alongside change-password

Related Issue

None. This is a documentation correction: the roster omitted one step of a
functional face the section itself covers.

Tests

  • cargo test — 579 passed, 0 failed
  • cargo fmt --check — clean
  • No new unit test: this changes no code. deploy_gate.rs:120 states
    outright that it does not cover docs/architecture.md (prose mention,
    not in its FILES), and no other gate parses this table
  • Verified against the source rather than the prose: reset_password takes
    no AuthUser (src/routes/mod.rs:502), change_password does
    (src/routes/mod.rs:607), and both are registered in router()

Section 6 groups the auth routes by their shared `POST /api/auth/` prefix and
named six of the seven. The missing one is `reset-password`, and it is the
half that makes password recovery work at all.

Its absence is not a dropped parallel option: `forgot-password` mails a code
and `reset-password` is the only place to submit it. The other password route
the roster does name, `change-password`, requires a Bearer session and the old
password, so it cannot serve anyone who has actually forgotten theirs. A
reader building a client from this line gets a flow that stops one step short.

Placed directly after `forgot-password` so the send-code and submit-code pair
reads adjacently. One entry added; the list stays a functional overview rather
than growing into the per-route inventory the section preamble disclaims.
@argszero
argszero merged commit eb4d5e2 into main Oct 19, 2026
2 checks passed
@argszero
argszero deleted the docs/auth-roster-reset-password branch October 19, 2026 09:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant