Skip to content

[Docs] Notify Email/SMS sending failure messages to end user on notification channel connectivity issues#6198

Merged
DilshanSenarath merged 2 commits into
wso2:masterfrom
DilshanSenarath:notify-provider-failures
Jun 21, 2026
Merged

[Docs] Notify Email/SMS sending failure messages to end user on notification channel connectivity issues#6198
DilshanSenarath merged 2 commits into
wso2:masterfrom
DilshanSenarath:notify-provider-failures

Conversation

@DilshanSenarath

Copy link
Copy Markdown
Contributor

@coderabbitai

coderabbitai Bot commented Jun 21, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@DilshanSenarath, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 52 minutes and 52 seconds. Learn how PR review limits work.

Your organization has run out of usage credits. Purchase more credits in the billing tab to continue.

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 89d419d1-70b6-442c-819e-eca013ff3e36

📥 Commits

Reviewing files that changed from the base of the PR and between 6bc22ca and 8fd8ae8.

📒 Files selected for processing (2)
  • en/includes/guides/authentication/mfa/add-emailotp-login.md
  • en/includes/guides/authentication/mfa/add-smsotp-login.md
📝 Walkthrough

Walkthrough

Two MFA setup guides—Email OTP and SMS OTP—are updated to add version/product-conditional content: a new screenshot for Identity Platform and Identity Server > 7.3.0, and a new "Notify users on OTP delivery failure" settings table row for the same conditions.

Changes

MFA OTP Setup Guide Updates

Layer / File(s) Summary
Version-conditional screenshot selection
en/includes/guides/authentication/mfa/add-emailotp-login.md, en/includes/guides/authentication/mfa/add-smsotp-login.md
Screenshots for the Settings tab in both guides now conditionally render a new image (setup-sms-otp-v2.png for SMS OTP) for WSO2 Identity Platform and Identity Server > 7.3.0, with the original image retained for all other versions.
Notify-on-failure setting and versioned settings tables
en/includes/guides/authentication/mfa/add-emailotp-login.md, en/includes/guides/authentication/mfa/add-smsotp-login.md
A conditional table row documenting "Notify users on OTP delivery failure" (disabled by default) is added to both guides for Identity Platform and Identity Server > 7.3.0. The SMS OTP guide preserves the existing 7.0.0/7.1.0 table and adds resend attempt count and resend block time fields to the default table.

Suggested labels

Team/Authentication & registration

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description is incomplete. It lacks required sections: Test environment and Security checks are missing; Purpose section only contains a placeholder ($subject). Complete the Purpose section with actual description, add Test environment details, and fill in Security checks with appropriate checkboxes and confirmations.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main documentation update: notifying end users about Email/SMS OTP sending failures on connectivity issues.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@en/includes/guides/authentication/mfa/add-emailotp-login.md`:
- Around line 87-95: The parenthetical example in the note within the "Notify
users on OTP delivery failure" table cell incorrectly describes a delivery
failure as "the email reaching the recipient's inbox" which is actually a
successful delivery, not a failure. Fix the example by rewording it to correctly
represent what a delivery failure actually is - the email not reaching the
recipient's inbox - so the description aligns with the setting name and
clarifies that some actual delivery failures may not be captured depending on
the provider.

In `@en/includes/guides/authentication/mfa/add-smsotp-login.md`:
- Around line 83-91: In the table description for the "Notify users on OTP
delivery failure" setting, correct the parenthetical example which currently
states delivery failures as "the SMS reaching the recipient's device" - this is
logically reversed. Change it to clarify that delivery failures mean the SMS
does NOT reach the recipient's device, making the explanation consistent with
the setting name and the overall description context.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yml

Review profile: CHILL

Plan: Pro

Run ID: 031f3644-861e-448e-a73e-d5f9c92e5302

📥 Commits

Reviewing files that changed from the base of the PR and between 018f886 and 6bc22ca.

⛔ Files ignored due to path filters (4)
  • en/asgardeo/docs/assets/img/guides/mfa/emailotp/setup-email-otp-v2.png is excluded by !**/*.png
  • en/asgardeo/docs/assets/img/guides/mfa/smsotp/setup-sms-otp-v2.png is excluded by !**/*.png
  • en/identity-server/next/docs/assets/img/guides/mfa/emailotp/setup-email-otp-v2.png is excluded by !**/*.png
  • en/identity-server/next/docs/assets/img/guides/mfa/smsotp/setup-sms-otp-v2.png is excluded by !**/*.png
📒 Files selected for processing (2)
  • en/includes/guides/authentication/mfa/add-emailotp-login.md
  • en/includes/guides/authentication/mfa/add-smsotp-login.md

Comment thread en/includes/guides/authentication/mfa/add-emailotp-login.md
Comment thread en/includes/guides/authentication/mfa/add-smsotp-login.md
@DilshanSenarath DilshanSenarath merged commit 9fc63ed into wso2:master Jun 21, 2026
3 of 5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants