docs(backend): Correct Dashboard labels in instance restrictions

[manovotny]

Description

Two TSDoc comments on the instance restrictions types bold Dashboard labels that don't match the Dashboard. Bold in these comments means "this is the name you'll see in the Dashboard," so a wrong one sends people looking for a control that isn't there.

blockDisposableEmailDomains reads Block sign-ups that use disposable email domains. The actual toggle is Block sign-ups that use disposable email addresses. Corrected in both places it appears.

ignoreDotsForGmailAddresses reads Ignore dots for Gmail addresses, but there's no such toggle. The Restrictions page renders four controls — restricted mode, allowlist/blocklist on sign-ins, block email subaddresses, and block disposable email addresses — and the setting appears only in the generated DAPI spec. The backend strips Gmail dots unconditionally in Canonical(). So there's nothing to name, and the bold comes off. UpdateRestrictionsParams already described the same field unbolded and lowercase, so the two now agree.

Property names are unchanged. blockDisposableEmailDomains is right — the check really is domain-based, matching the address's domain against a disposable-domain list. Only the human-facing labels were wrong.

Found while reviewing clerk/clerk#3034, which touches the docs page these comments link to. The linked anchors are unchanged and still resolve.

Worth flagging for whoever picks this up: "addresses" (Dashboard, docs, pricing table) versus "domains" (these properties, the BAPI field) is a naming split that runs wider than these lines. This fixes what's provably wrong against the Dashboard and leaves the split alone.

Checklist

• pnpm test runs as expected.
• pnpm build runs as expected.
• (If applicable) JSDoc comments have been added or updated for any package exports
• (If applicable) Documentation has been updated

Type of change

• 🐛 Bug fix
• 🌟 New feature
• 🔨 Breaking change
• 📖 Refactoring / dependency upgrade / documentation
• other:

[vercel]

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

Project	Deployment	Actions	Updated (UTC)
clerk-js-sandbox	Ready	Preview, Comment	Jul 27, 2026 3:58pm
swingset	Ready	Preview, Comment	Jul 27, 2026 3:58pm

[changeset-bot]

🦋 Changeset detected

Latest commit: 1bf6b4a

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 10 packages

Name	Type
@clerk/backend	Patch
@clerk/astro	Patch
@clerk/express	Patch
@clerk/fastify	Patch
@clerk/hono	Patch
@clerk/nextjs	Patch
@clerk/nuxt	Patch
@clerk/react-router	Patch
@clerk/tanstack-react-start	Patch
@clerk/testing	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[pkg-pr-new]

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@9253

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@9253

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@9253

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@9253

@clerk/electron

npm i https://pkg.pr.new/@clerk/electron@9253

@clerk/electron-passkeys

npm i https://pkg.pr.new/@clerk/electron-passkeys@9253

@clerk/eslint-plugin

npm i https://pkg.pr.new/@clerk/eslint-plugin@9253

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@9253

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9253

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@9253

@clerk/express

npm i https://pkg.pr.new/@clerk/express@9253

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@9253

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@9253

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@9253

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@9253

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@9253

@clerk/react

npm i https://pkg.pr.new/@clerk/react@9253

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@9253

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@9253

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@9253

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@9253

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@9253

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@9253

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@9253

commit: 1bf6b4a

[github-actions]

API Changes Report

Generated by Break Check on 2026-07-27T16:07:08.446Z

Summary

Metric	Count
Packages analyzed	19
Packages with changes	0
🔴 Breaking changes	0
🟡 Non-breaking changes	0
🟢 Additions	0

No API Changes Detected

All packages have stable APIs with no detected changes.

---

Report generated by Break Check

_{Last ran on 1bf6b4a.}

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: CHILL

Plan: Pro Plus

Run ID: ba7c0ae0-aa86-4482-b2c4-b2b32aecafef

📥 Commits

Reviewing files that changed from the base of the PR and between f5d84fe and 1bf6b4a.

📒 Files selected for processing (3)

• .changeset/fix-disposable-email-toggle-label.md
• packages/backend/src/api/endpoints/InstanceApi.ts
• packages/backend/src/api/resources/InstanceRestrictions.ts

🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

• clerk/clerk_go (manual)
• clerk/dashboard (manual)
• clerk/accounts (manual)
• clerk/backoffice (manual)
• clerk/clerk (manual) → reviewed against open PR #3034 bsid/yahoo-subaddressing instead of the default branch
• clerk/clerk-docs (manual)
• clerk/cloudflare-workers (manual)
• clerk/clerk-ios (auto-detected)
• clerk/clerk-android (auto-detected)
• clerk/cli (auto-detected)

---

📝 Walkthrough

Walkthrough

Updated instance restriction documentation to describe disposable email addresses and aligned related Dashboard label text. Added a patch changeset for @clerk/backend. No runtime logic, property names, types, or API shapes changed.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: alexisintech

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly describes the documentation label corrections in backend instance restrictions.
Description check	✅ Passed	The description matches the PR by explaining the corrected Dashboard labels and unchanged property names.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

---

_{Comment @coderabbitai help to get the list of available commands.}