docs: api comments say what the endpoints do, not how they came to be (#6277)
Rewrites the internal/api comment blocks to rule 32: task, milestone and rule ids gone, the stories behind them restated as the constraint they left, stale references corrected (the stream secret is wired from config, the timezone handler already refreshes the scheduler, the Android app is the native client, the design docs cited are not in the repo). Also rewraps comment lines over 80 columns left by the earlier batches. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
+7
-13
@@ -10,20 +10,14 @@ import (
|
||||
|
||||
// handleGetMe returns the authenticated user's profile shape — id,
|
||||
// username, display_name, email, is_admin. Mirrors the response shape
|
||||
// of PUT /api/me/profile so the Android Settings → Profile screen
|
||||
// (and Flutter's equivalent) can read its starting state from a GET
|
||||
// before the user has done a first save.
|
||||
// of PUT /api/me/profile so the Android Settings → Profile screen can
|
||||
// read its starting state from a GET before the user has done a first
|
||||
// save.
|
||||
//
|
||||
// Drift #578 fix: this previously emitted the narrower UserView
|
||||
// (id, username, is_admin only). Android's MeApi.getProfile() deser-
|
||||
// ialised into MyProfileWire and saw display_name=null, email=null
|
||||
// on every read — wiping the form fields on every Settings open.
|
||||
// Saving from that blank state then submitted empty strings, which
|
||||
// handleUpdateMyProfile treats as "clear to NULL" — DESTROYING the
|
||||
// user's stored display_name + email. Returning the full profile
|
||||
// shape here closes the loop. Web (User type narrower than this
|
||||
// response) keeps working via TypeScript structural typing — the
|
||||
// extra fields are ignored.
|
||||
// The full profile matters: a form seeded with display_name=null and
|
||||
// email=null would, on save, submit empty strings, which
|
||||
// handleUpdateMyProfile treats as "clear to NULL" — destroying the stored
|
||||
// values. The web app's narrower User type ignores the extra fields.
|
||||
func (h *handlers) handleGetMe(w http.ResponseWriter, r *http.Request) {
|
||||
user, ok := auth.UserFromContext(r.Context())
|
||||
if !ok {
|
||||
|
||||
Reference in New Issue
Block a user