[codex] correct auth user API example#41
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
There was a problem hiding this comment.
Mogplex PR Review
Status: Attention needed
This is a clean, well-scoped documentation fix that correctly restores the /api/auth/user response example to match the live API shape (platform_access, allowPlatformAi, allowPlatformSandbox, and vercel.personalState). No code, logic, or security concerns. One minor prose clarity issue worth addressing before merging.
1 finding was added inline.
|
|
||
| Current API field names still use `platform_access` and `allowPlatform*`. | ||
| Treat those fields as the route's managed account-access flags. | ||
|
|
There was a problem hiding this comment.
Suggestion: Prose note could imply upcoming deprecation
The sentence "Current API field names still use platform_access and allowPlatform*." uses "still use" in a way that implies a future rename is planned or in progress. A reader scanning the docs may reasonably conclude these field names are transitional and will change soon, and may write defensive code against that assumption.
If no rename is planned, consider replacing the note with something unambiguous, e.g.:
The managed account-access flags are exposed under
platform_accesswithallowPlatformAiandallowPlatformSandboxsub-fields.
If a rename is planned, a brief note like "(these names will change in a future release)" would make the intent explicit.
Summary
Follow-up to PR #40 review feedback.
/api/auth/userexample response to the current API shape:platform_access.allowPlatformAi,platform_access.allowPlatformSandbox, andvercel.personalStateWhy
PR #40 intentionally reframed the docs around managed billing, but the
working-requestsexample renamed response fields ahead of the app contract. The app currently returnsplatform_access, so the docs example should match live behavior.Validation
git diff --checkpnpm lintpnpm types:checkpnpm buildpnpm lint,pnpm types:check, andpnpm buildNeed help on this PR? Tag
@codesmithwith what you need.