docs: add OIDCHandler error table and Cache-Control response header notes

[github-actions]

Summary

Three documentation gaps identified during a full audit of handler source code vs. README:

1. Cache-Control: no-store / Pragma: no-cache on AuthHandler responses

AuthHandler.Signup, Login, and RefreshToken all set these headers in code (handler/auth.go:140,189,281) but the README's Response types section didn't mention them. APIKeyHandler.Create and TOTPHandler.Generate already had this documented — this brings AuthHandler into parity.

2. Same headers on MagicLinkHandler.VerifyMagicLink

handler/magiclink.go:125-126 sets Cache-Control: no-store and Pragma: no-cache, which was also unmentioned in the response types section.

3. Missing OIDCHandler error table

Every other handler section has a structured Error responses table, but OIDCHandler only had narrative paragraphs. This adds a table covering:

Endpoint	Status codes
Login	500
Callback	400, 401, 500
CreateLinkNonce	always 200 OK
Link	400, 401, 409

The existing redirect-outcome table and the two blockquote notes are preserved unchanged.

---

Files changed: README.md only (+17 lines, -2 lines)

Warning

⚠️ Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

• proxy.golang.org

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "proxy.golang.org"

See Network Configuration for more information.

Generated by Update Docs · ● 2.3M · ◷

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/update-docs.md@96b9d4c39aa22359c0b38265927eadb31dcf4e2a

Greptile Summary

Documentation-only update to README.md that adds Cache-Control: no-store / Pragma: no-cache notes to AuthHandler (Signup, Login, RefreshToken) and MagicLinkHandler.VerifyMagicLink, and refines the Link 409 Conflict condition description in the OIDC error table. All three changes are verified accurate against the corresponding handler source files (handler/auth.go:140,189,281, handler/magiclink.go:125–126, handler/oidc.go:280).

Confidence Score: 5/5

README-only change; all documented behaviors verified accurate against handler source code.

Every claim in the three updated paragraphs was cross-checked against the Go source. Previous P1 findings (inaccurate PKCE 400 description, misleading (none) status cell) were fixed in 523c1b1. No remaining P0/P1 issues.

No files require special attention.

Important Files Changed

Filename	Overview
README.md	Three targeted prose edits: Cache-Control header notes added for AuthHandler and MagicLinkHandler, and 409 Conflict condition wording refined for OIDCHandler.Link — all accurate against source.

Sequence Diagram

sequenceDiagram
    participant Client
    participant AuthHandler
    participant MagicLinkHandler

    Client->>AuthHandler: POST /signup or /login or /refresh
    AuthHandler-->>Client: 200/201 with Cache-Control: no-store and Pragma: no-cache

    Client->>MagicLinkHandler: GET /verify
    MagicLinkHandler-->>Client: 200 with Cache-Control: no-store and Pragma: no-cache

Loading

_{Reviews (3): Last reviewed commit: "chore: merge origin/main and resolve REA..." | Re-trigger Greptile}

[Copilot]

Pull request overview

Updates README handler documentation to close gaps discovered during an audit, focusing on response headers for token-issuing endpoints and adding a structured error table for OIDC flows.

Changes:

• Document Cache-Control: no-store and Pragma: no-cache on successful AuthHandler token responses (Signup, Login, RefreshToken).
• Document the same anti-caching headers on MagicLinkHandler.VerifyMagicLink success responses.
• Add an OIDCHandler “Error responses” table to match the structure used by other handler sections.

Show a summary per file

File	Description
README.md	Adds missing header notes for token responses and introduces an OIDC error-response table for consistency and completeness.

Copilot's findings

Tip

Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

• Files reviewed: 1/1 changed files
• Comments generated: 2