Repository navigation
docs(architecture): list reset-password in the auth endpoint roster - #421
Merged
Merged
Conversation
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.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Section 6 of
docs/architecture.mdgroups the auth routes under their sharedPOST /api/auth/prefix and named six of the seven. The missing one isreset-password, and it is the half that makes password recovery work at all.forgot-passwordreset-passwordchange-passwordSo 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 adead endpoint.
Changes
docs/architecture.md:82—reset-passwordadded to the auth roster,placed directly after
forgot-passwordso the send-code and submit-codepair reads adjacently
a functional overview, not a per-route inventory, so the fix closes the
recovery face without turning the table into something it disclaims
ui/README.md:899already namesreset-passwordalongsidechange-passwordRelated 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 failedcargo fmt --check— cleandeploy_gate.rs:120statesoutright that it does not cover
docs/architecture.md(prose mention,not in its
FILES), and no other gate parses this tablereset_passwordtakesno
AuthUser(src/routes/mod.rs:502),change_passworddoes(
src/routes/mod.rs:607), and both are registered inrouter()