Add architecture diagram and GET workflow diagrams to README#35
Add architecture diagram and GET workflow diagrams to README#35darthnithin wants to merge 1 commit intomainfrom
Conversation
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6f686a8615
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| API->>Cache: read session | ||
| alt cache miss/expired | ||
| API->>GET: authenticate | ||
| API->>Cache: write session |
There was a problem hiding this comment.
Align barcode-refresh diagram with actual session handling
The diagram currently shows a "Session Cache" read/write path, but /api/get/barcode does not use a cache layer: it calls getActiveGetSessionForUser, which re-authenticates via authenticatePin on each request (lib/get/server.ts) before fetching the barcode (app/api/get/barcode/route.ts). This mismatch can mislead maintainers/integrators into expecting cache-backed behavior and stale-session semantics that do not exist in production.
Useful? React with 👍 / 👎.
| API->>GET: retrieve current barcode payload | ||
| API-->>FE: active state + payload |
There was a problem hiding this comment.
Fix fulfillment diagram to avoid implying scan-state returns QR data
In the "no drop" branch, the diagram says scan-state retrieves barcode payload and returns active state + payload, but GET /api/get/scan-state only returns status metadata (state, lastCheckedAt, expiresAt) and never returns barcode data; barcode payload is served by a separate endpoint (/api/get/barcode). This documentation error can cause client implementations to call the wrong endpoint and miss QR payloads.
Useful? React with 👍 / 👎.
Motivation
Description
README.mdto include the new diagrams and section headers without changing application code or runtime behavior.Testing
npm run lintagainst the repository and the linter completed successfully.Codex Task