Skip to content

docs: services.sms 服务参考 + 手机号 OTP 认证文档(#2780 补全) - #2809

Merged
os-zhuang merged 1 commit into
mainfrom
claude/sms-infrastructure-phone-otp-9tisdu
Jul 11, 2026
Merged

docs: services.sms 服务参考 + 手机号 OTP 认证文档(#2780 补全)#2809
os-zhuang merged 1 commit into
mainfrom
claude/sms-infrastructure-phone-otp-9tisdu

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

#2780 系列(#2790 / #2797 / objectui#2388)落了代码但没有配套手写文档,本 PR 补全。按实现逐条核对(非 drift-check 全量清单,只改真实相关的):

变更

  • 新增 content/docs/kernel/runtime-services/sms-service.mdx(完全对齐 email-service.mdx 的版式):services.sms.send / isConfigured 契约、不落库不记正文红线、sms 设置命名空间(阿里云/Twilio 各键 + OS_SMS_* env 覆盖 + 测试动作)、三个消费方(auth OTP / messaging sms channel / 导入短信邀请)。已注册进 meta.json 与 index 的 Source of Truth 列表。
  • content/docs/permissions/authentication.mdx 新增「Phone-Number Authentication (SMS OTP)」章节:OS_AUTH_PHONE_NUMBER_ENABLED 开关、手机号+密码登录、四个 OTP 端点(features.phoneNumberOtp 门控语义)、滥用防护全览(准入冷却/小时配额、allowedAttempts=3、per-IP 限流、重置端点无账号枚举、OTP 零日志)、导入 invite 策略的短信邀请变体。
  • 空 changeset(docs-only,无包变更)。

验证

  • pnpm docs:build(Next.js 静态构建)本地通过;MDX 风险符号(<random>${content})均置于行内代码。
  • references/api/auth.mdx 为自动生成文件,未手改(由 build-docs.ts 从 spec 再生)。

🤖 Generated with Claude Code

https://claude.ai/code/session_013LXUXU66dBaP3SSG4ZVtuH


Generated by Claude Code

…2780)

The #2780 line shipped code without hand-written docs:

- new kernel/runtime-services/sms-service.mdx (mirrors email-service.mdx):
  send/isConfigured surface, no-persistence/no-body-logging red line,
  provider configuration via the `sms` settings namespace, consumers
  (auth OTP, messaging sms channel, import SMS invitations)
- permissions/authentication.mdx: Phone-Number Authentication section -
  OS_AUTH_PHONE_NUMBER_ENABLED, phone+password sign-in, the four OTP
  endpoints gated on a deliverable SMS service (features.phoneNumberOtp),
  abuse hardening (admission cooldown/cap, allowedAttempts, per-IP rules,
  no-oracle reset), import SMS invitations
- runtime-services index + meta: register the new page

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_013LXUXU66dBaP3SSG4ZVtuH
@vercel

vercel Bot commented Jul 11, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
spec Ready Ready Preview, Comment Jul 11, 2026 1:29am

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation tooling size/m and removed documentation Improvements or additions to documentation tooling labels Jul 11, 2026
@os-zhuang
os-zhuang marked this pull request as ready for review July 11, 2026 01:35
@os-zhuang
os-zhuang merged commit 7254bd0 into main Jul 11, 2026
15 checks passed
@os-zhuang
os-zhuang deleted the claude/sms-infrastructure-phone-otp-9tisdu branch July 11, 2026 01:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants