Skip to content

[codex] correct auth user API example#41

Merged
charlesrhoward merged 1 commit into
mainfrom
codex/docs-auth-user-response-followup
May 18, 2026
Merged

[codex] correct auth user API example#41
charlesrhoward merged 1 commit into
mainfrom
codex/docs-auth-user-response-followup

Conversation

@charlesrhoward
Copy link
Copy Markdown
Contributor

@charlesrhoward charlesrhoward commented May 18, 2026

Summary

Follow-up to PR #40 review feedback.

  • restore the /api/auth/user example response to the current API shape: platform_access.allowPlatformAi, platform_access.allowPlatformSandbox, and vercel.personalState
  • keep the managed-billing framing by noting that the current API names are the route's managed account-access flags

Why

PR #40 intentionally reframed the docs around managed billing, but the working-requests example renamed response fields ahead of the app contract. The app currently returns platform_access, so the docs example should match live behavior.

Validation

  • git diff --check
  • pnpm lint
  • pnpm types:check
  • pnpm build
  • pre-push hook reran pnpm lint, pnpm types:check, and pnpm build

View in Codesmith
Need help on this PR? Tag @codesmith with what you need.

  • Let Codesmith autofix CI failures and bot reviews

@vercel
Copy link
Copy Markdown

vercel Bot commented May 18, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
mogplex-docs Ready Ready Preview, Comment May 18, 2026 7:28pm

Request Review

@charlesrhoward charlesrhoward marked this pull request as ready for review May 18, 2026 19:28
@charlesrhoward charlesrhoward merged commit f733330 into main May 18, 2026
5 checks passed
@charlesrhoward charlesrhoward deleted the codex/docs-auth-user-response-followup branch May 18, 2026 19:28
Copy link
Copy Markdown

@mogplex mogplex Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

View check run


Current API field names still use `platform_access` and `allowPlatform*`.
Treat those fields as the route's managed account-access flags.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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_access with allowPlatformAi and allowPlatformSandbox sub-fields.

If a rename is planned, a brief note like "(these names will change in a future release)" would make the intent explicit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant