auth.md: clarify status codes vs redirect for OAuth error modes

Aperta Adatta ai principianti
#42 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
82/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Tranquilla
Ambito
authentication, documentation

Direzione di ricerca

Inizia dalla sezione Errors di specs/api/auth.md, quindi confronta le relative modalità di errore OAuth con il piano github-oauth e specs/screens/login.md. Aggiorna la specifica in modo che gli errori dei callback del browser documentino coerentemente reindirizzamenti con ?error=, mantenendo i soli codici di stato per i chiamanti non browser se tale distinzione è specificata.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

The Errors section of specs/api/auth.md lists `oauth_state_mismatch` and `oauth_session_invalid` as `401 unauthenticated` responses, while `github_unreachable` and `email_unverified` are documented as `502`/`403` with explicit redirect to `/login?error=`.

The github-oauth plan adopts the redirect strategy uniformly: every failure mode in the browser OAuth callback redirects to `/login?error=`. That matches specs/screens/login.md which expects `?error=` rendering, and is what makes sense for a callback the browser hits directly.

Should the spec be updated to:

  • list every OAuth error as 'redirect with `?error=`' (the actual user experience), and
  • reserve the bare-status-code shape for non-browser callers (e.g., if the API ever exposes the same flow to a CLI client)?

Filed in the github-oauth closeout — non-blocking for that plan, but worth a small spec edit.
Lingua principale
TypeScript
Stelle
1
Fork
1
Merge medio
1g 20h
PR unite (30g)
25

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di CodeForPhilly/codeforphilly-ng

Tutte le issue di CodeForPhilly/codeforphilly-ng

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.