diff --git a/.changeset/fix-disposable-email-toggle-label.md b/.changeset/fix-disposable-email-toggle-label.md new file mode 100644 index 00000000000..b3d95a583ed --- /dev/null +++ b/.changeset/fix-disposable-email-toggle-label.md @@ -0,0 +1,5 @@ +--- +'@clerk/backend': patch +--- + +Correct two Dashboard labels referenced in the instance restrictions documentation. `blockDisposableEmailDomains` bolded "Block sign-ups that use disposable email domains", but the toggle in the Clerk Dashboard is "Block sign-ups that use disposable email addresses". `ignoreDotsForGmailAddresses` bolded "Ignore dots for Gmail addresses" as a Dashboard toggle, but no such control exists — the wording now matches the equivalent comment on `UpdateRestrictionsParams`. Property names are unchanged. diff --git a/packages/backend/src/api/endpoints/InstanceApi.ts b/packages/backend/src/api/endpoints/InstanceApi.ts index c304ddf0c5c..884dbd84528 100644 --- a/packages/backend/src/api/endpoints/InstanceApi.ts +++ b/packages/backend/src/api/endpoints/InstanceApi.ts @@ -36,7 +36,7 @@ export type UpdateRestrictionsParams = { blocklist?: boolean | null | undefined; /** Whether the instance should have [**Block email subaddresses**](https://clerk.com/docs/guides/secure/restricting-access#block-email-subaddresses) enabled. */ blockEmailSubaddresses?: boolean | null | undefined; - /** Whether the instance should have [**Block sign-ups that use disposable email domains**](https://clerk.com/docs/guides/secure/restricting-access#block-sign-ups-that-use-disposable-email-addresses) enabled. */ + /** Whether the instance should have [**Block sign-ups that use disposable email addresses**](https://clerk.com/docs/guides/secure/restricting-access#block-sign-ups-that-use-disposable-email-addresses) enabled. */ blockDisposableEmailDomains?: boolean | null | undefined; /** Whether the instance should [ignore dots for Gmail addresses](https://clerk.com/docs/guides/secure/restricting-access#block-email-subaddresses). */ ignoreDotsForGmailAddresses?: boolean | null | undefined; diff --git a/packages/backend/src/api/resources/InstanceRestrictions.ts b/packages/backend/src/api/resources/InstanceRestrictions.ts index 679f50539ec..3a4ebcc2c90 100644 --- a/packages/backend/src/api/resources/InstanceRestrictions.ts +++ b/packages/backend/src/api/resources/InstanceRestrictions.ts @@ -9,9 +9,9 @@ export class InstanceRestrictions { readonly blocklist: boolean, /** Whether the instance has [**Block email subaddresses**](https://clerk.com/docs/guides/secure/restricting-access#block-email-subaddresses) enabled. */ readonly blockEmailSubaddresses: boolean, - /** Whether the instance has [**Block sign-ups that use disposable email domains**](https://clerk.com/docs/guides/secure/restricting-access#block-sign-ups-that-use-disposable-email-addresses) enabled. */ + /** Whether the instance has [**Block sign-ups that use disposable email addresses**](https://clerk.com/docs/guides/secure/restricting-access#block-sign-ups-that-use-disposable-email-addresses) enabled. */ readonly blockDisposableEmailDomains: boolean, - /** Whether the instance has [**Ignore dots for Gmail addresses**](https://clerk.com/docs/guides/secure/restricting-access#block-email-subaddresses) enabled. */ + /** Whether the instance is set to [ignore dots for Gmail addresses](https://clerk.com/docs/guides/secure/restricting-access#block-email-subaddresses). */ readonly ignoreDotsForGmailAddresses: boolean, ) {}