Fix: Add sendEmail documentation for non-existent users for all affected versions (Product IS issue #27610)#6076
Open
wso2-engineering-bot wants to merge 1 commit intomasterfrom
Conversation
…ted versions (product-is#27610) Updated the sendEmail function documentation across all version directories to include information about sending emails to users who do not exist in the identity server by using the 'send-to' and 'flowType' parameters. Versions updated: 5.9.0, 5.10.0, 5.11.0, 6.0.0, 6.1.0, 7.0.0, 7.1.0, 7.2.0, next Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
|
wso2-engineering-bot seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
Contributor
📝 WalkthroughWalkthroughThe pull request updates the Changes
Suggested labels
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Nitpick comments (7)
en/identity-server/5.9.0/docs/references/adaptive-authentication-js-api-reference.md (1)
218-218: Use the official product name in the new parameter description.In Line 218, replace “identity server” with
WSO2 Identity Serverfor naming consistency in newly added content.As per coding guidelines, "Use official product and feature names exactly as defined; do not invent shorthand names, change capitalization..."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/identity-server/5.9.0/docs/references/adaptive-authentication-js-api-reference.md` at line 218, Update the newly added description for the placeholderParameters parameter so the product name is exact: replace the phrase "identity server" with "WSO2 Identity Server" in the text under the placeholderParameters entry (the paragraph that mentions sending emails to users who do not exist in the identity server) to match official naming conventions.en/identity-server/6.0.0/docs/references/adaptive-authentication-js-api-reference.md (1)
236-236: Use official product naming in this added sentence.Line 236 should refer to
WSO2 Identity Serverinstead of “identity server”.As per coding guidelines, "Use official product and feature names exactly as defined; do not invent shorthand names, change capitalization..."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/identity-server/6.0.0/docs/references/adaptive-authentication-js-api-reference.md` at line 236, The added description for placeholderParameters uses the lowercase phrase "identity server"; update that text to use the official product name "WSO2 Identity Server". Edit the string in the documentation block where placeholderParameters is defined (the line containing the `send-to` and `flowType` bullets) and replace "identity server" with "WSO2 Identity Server" so the `send-to` description reads: "Use this to send emails to users who do not exist in WSO2 Identity Server." Ensure other occurrences (if any) in the same paragraph referencing the product follow the same capitalization.en/identity-server/7.1.0/docs/references/conditional-auth/api-reference.md (1)
696-696: Update product name capitalization in the new text.In Line 696, use
WSO2 Identity Serverrather than “identity server”.As per coding guidelines, "Use official product and feature names exactly as defined; do not invent shorthand names, change capitalization..."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/identity-server/7.1.0/docs/references/conditional-auth/api-reference.md` at line 696, The list item describing <code>send-to</code> uses lowercase "identity server"; update that phrase to the official product name "WSO2 Identity Server" so the line reads: "Use this to send emails to users who do not exist in the WSO2 Identity Server." Locate the <code>send-to</code> list item in the conditional-auth api-reference content and replace the lowercase instance with the exact product name, preserving the rest of the sentence and code formatting.en/identity-server/7.2.0/docs/references/conditional-auth/api-reference.md (1)
700-700: Use official product naming in the added field description.Line 700 should use
WSO2 Identity Serverinstead of “identity server” for consistency with product terminology.As per coding guidelines, "Use official product and feature names exactly as defined; do not invent shorthand names, change capitalization..."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/identity-server/7.2.0/docs/references/conditional-auth/api-reference.md` at line 700, Update the description for the field <code>send-to</code> so it uses the official product name: replace the phrase "identity server" with "WSO2 Identity Server" in the sentence that reads "Use this to send emails to users who do not exist in the identity server."en/identity-server/5.11.0/docs/references/adaptive-authentication-js-api-reference.md (1)
245-245: Normalize product naming in this new sentence.In Line 245, use
WSO2 Identity Serverinstead of “identity server” to keep official naming consistent.As per coding guidelines, "Use official product and feature names exactly as defined; do not invent shorthand names, change capitalization..."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/identity-server/5.11.0/docs/references/adaptive-authentication-js-api-reference.md` at line 245, Update the descriptive text for the placeholderParameters entry so the sentence that currently reads "Use this to send emails to users who do not exist in the identity server." uses the official product name "WSO2 Identity Server" instead of "identity server"; look for the placeholderParameters block and the optional fields `send-to` and `flowType` in the API reference and replace only that instance with "WSO2 Identity Server" to maintain product-name consistency.en/identity-server/next/docs/references/conditional-auth/api-reference.md (1)
700-700: Use the canonical product name here.In Line 700, replace “identity server” with
WSO2 Identity Serverto match official naming.As per coding guidelines, "Use official product and feature names exactly as defined; do not invent shorthand names, change capitalization..."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/identity-server/next/docs/references/conditional-auth/api-reference.md` at line 700, Replace the lowercase phrase "identity server" in the description for the <code>send-to</code> item with the official product name "WSO2 Identity Server"; update the text that currently reads "identity server" to "WSO2 Identity Server" so the <code>send-to</code> list item uses the canonical product name.en/identity-server/7.0.0/docs/references/conditional-auth/api-reference.md (1)
694-694: Keep official product naming in the added docs.Line 694 should use
WSO2 Identity Serverinstead of “identity server”.As per coding guidelines, "Use official product and feature names exactly as defined; do not invent shorthand names, change capitalization..."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/identity-server/7.0.0/docs/references/conditional-auth/api-reference.md` at line 694, The docs list item for the <code>send-to</code> field uses the lowercase phrase "identity server"; update that text to use the official product name "WSO2 Identity Server" (i.e., change "identity server" to "WSO2 Identity Server" in the <code>send-to</code> description) so the product name and capitalization match the coding guidelines.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@en/identity-server/5.10.0/docs/references/adaptive-authentication-js-api-reference.md`:
- Line 218: Update the description for the parameter named placeholderParameters
to use the official product name: replace the phrase "identity server" with
"WSO2 Identity Server" in the sentence that explains sending emails to users who
do not exist in the identity server; ensure the rest of the wording and
formatting (including the `send-to` and `flowType` bullets) remain unchanged.
In
`@en/identity-server/6.1.0/docs/references/adaptive-authentication-js-api-reference.md`:
- Line 275: The documentation entry for placeholderParameters uses the lowercase
phrase "identity server"; update the text associated with placeholderParameters
to use the official product name "WSO2 Identity Server" (e.g., change "identity
server" to "WSO2 Identity Server" in the sentence describing sending emails to
users who do not exist in the identity server) so the parameter description
follows product-naming guidelines.
---
Nitpick comments:
In
`@en/identity-server/5.11.0/docs/references/adaptive-authentication-js-api-reference.md`:
- Line 245: Update the descriptive text for the placeholderParameters entry so
the sentence that currently reads "Use this to send emails to users who do not
exist in the identity server." uses the official product name "WSO2 Identity
Server" instead of "identity server"; look for the placeholderParameters block
and the optional fields `send-to` and `flowType` in the API reference and
replace only that instance with "WSO2 Identity Server" to maintain product-name
consistency.
In
`@en/identity-server/5.9.0/docs/references/adaptive-authentication-js-api-reference.md`:
- Line 218: Update the newly added description for the placeholderParameters
parameter so the product name is exact: replace the phrase "identity server"
with "WSO2 Identity Server" in the text under the placeholderParameters entry
(the paragraph that mentions sending emails to users who do not exist in the
identity server) to match official naming conventions.
In
`@en/identity-server/6.0.0/docs/references/adaptive-authentication-js-api-reference.md`:
- Line 236: The added description for placeholderParameters uses the lowercase
phrase "identity server"; update that text to use the official product name
"WSO2 Identity Server". Edit the string in the documentation block where
placeholderParameters is defined (the line containing the `send-to` and
`flowType` bullets) and replace "identity server" with "WSO2 Identity Server" so
the `send-to` description reads: "Use this to send emails to users who do not
exist in WSO2 Identity Server." Ensure other occurrences (if any) in the same
paragraph referencing the product follow the same capitalization.
In `@en/identity-server/7.0.0/docs/references/conditional-auth/api-reference.md`:
- Line 694: The docs list item for the <code>send-to</code> field uses the
lowercase phrase "identity server"; update that text to use the official product
name "WSO2 Identity Server" (i.e., change "identity server" to "WSO2 Identity
Server" in the <code>send-to</code> description) so the product name and
capitalization match the coding guidelines.
In `@en/identity-server/7.1.0/docs/references/conditional-auth/api-reference.md`:
- Line 696: The list item describing <code>send-to</code> uses lowercase
"identity server"; update that phrase to the official product name "WSO2
Identity Server" so the line reads: "Use this to send emails to users who do not
exist in the WSO2 Identity Server." Locate the <code>send-to</code> list item in
the conditional-auth api-reference content and replace the lowercase instance
with the exact product name, preserving the rest of the sentence and code
formatting.
In `@en/identity-server/7.2.0/docs/references/conditional-auth/api-reference.md`:
- Line 700: Update the description for the field <code>send-to</code> so it uses
the official product name: replace the phrase "identity server" with "WSO2
Identity Server" in the sentence that reads "Use this to send emails to users
who do not exist in the identity server."
In `@en/identity-server/next/docs/references/conditional-auth/api-reference.md`:
- Line 700: Replace the lowercase phrase "identity server" in the description
for the <code>send-to</code> item with the official product name "WSO2 Identity
Server"; update the text that currently reads "identity server" to "WSO2
Identity Server" so the <code>send-to</code> list item uses the canonical
product name.
🪄 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: d395d14a-c0e8-4e84-863c-c99ef5894a5b
📒 Files selected for processing (9)
en/identity-server/5.10.0/docs/references/adaptive-authentication-js-api-reference.mden/identity-server/5.11.0/docs/references/adaptive-authentication-js-api-reference.mden/identity-server/5.9.0/docs/references/adaptive-authentication-js-api-reference.mden/identity-server/6.0.0/docs/references/adaptive-authentication-js-api-reference.mden/identity-server/6.1.0/docs/references/adaptive-authentication-js-api-reference.mden/identity-server/7.0.0/docs/references/conditional-auth/api-reference.mden/identity-server/7.1.0/docs/references/conditional-auth/api-reference.mden/identity-server/7.2.0/docs/references/conditional-auth/api-reference.mden/identity-server/next/docs/references/conditional-auth/api-reference.md
| | user | An object representing the user details. | | ||
| | templateId | Identifier of the email template. The email template specifies the body of the email that is sent out. | | ||
| | placeholderParameters | Used to replace any placeholders in the template. | | ||
| | placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> | |
Contributor
There was a problem hiding this comment.
Use the official product name in the new parameter description.
Please replace “identity server” with the official product name (for example, WSO2 Identity Server) to keep naming consistent and searchable across docs.
Suggested edit
-| placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> |
+| placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in WSO2 Identity Server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> |As per coding guidelines: "Use official product and feature names exactly as defined; do not invent shorthand names, change capitalization..."
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| | placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> | | |
| | placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in WSO2 Identity Server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> | |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In
`@en/identity-server/5.10.0/docs/references/adaptive-authentication-js-api-reference.md`
at line 218, Update the description for the parameter named
placeholderParameters to use the official product name: replace the phrase
"identity server" with "WSO2 Identity Server" in the sentence that explains
sending emails to users who do not exist in the identity server; ensure the rest
of the wording and formatting (including the `send-to` and `flowType` bullets)
remain unchanged.
| | user | An object representing the user details. | | ||
| | templateId | Identifier of the email template. The email template specifies the body of the email that is sent out. | | ||
| | placeholderParameters | Used to replace any placeholders in the template. | | ||
| | placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> | |
Contributor
There was a problem hiding this comment.
Standardize product naming in the new placeholderParameters text.
The phrase “identity server” should use the official product name/capitalization for consistency (WSO2 Identity Server).
Suggested edit
-| placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> |
+| placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in WSO2 Identity Server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> |As per coding guidelines: "Use official product and feature names exactly as defined; do not invent shorthand names, change capitalization..."
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| | placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in the identity server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> | | |
| | placeholderParameters | Used to replace any placeholders in the template.<br/><br/>This parameter also supports the following optional fields:<br/><ul><li>`send-to`: Specifies the email address to send the email to. Use this to send emails to users who do not exist in WSO2 Identity Server.</li><li>`flowType`: Specifies the flow type. Set this to `registration` when sending emails to non-existent users.</li></ul> | |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In
`@en/identity-server/6.1.0/docs/references/adaptive-authentication-js-api-reference.md`
at line 275, The documentation entry for placeholderParameters uses the
lowercase phrase "identity server"; update the text associated with
placeholderParameters to use the official product name "WSO2 Identity Server"
(e.g., change "identity server" to "WSO2 Identity Server" in the sentence
describing sending emails to users who do not exist in the identity server) so
the parameter description follows product-naming guidelines.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR was automatically generated by Claude AI.
sendEmailfunction documentation to include information about sending emails to users who do not exist in the identity server. This is achieved by using thesend-toparameter to specify the email address and setting theflowTypeparameter toregistrationin theplaceholderParametersobject.Changes made:
send-toandflowTypeparameters in theplaceholderParametersfield🤖 Generated with Claude Code