Fix spelling issues#6071
Merged
Merged
Conversation
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
✅ Files skipped from review due to trivial changes (2)
📝 WalkthroughWalkthroughBulk documentation-only fixes: spelling, grammar, vocabulary, and example URL placeholder corrections across Asgardeo and multiple WSO2 Identity Server versions and includes; no API signatures, schemas (beyond description text), or functional code were changed. Changes
Suggested labels
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 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: 15
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (11)
en/includes/guides/authentication/passwordless-login/add-passwordless-login-with-hypr.md (1)
55-55:⚠️ Potential issue | 🟠 MajorReplace informal UI label text to fix Vale failure
Line 55 uses Advanced Config. Update it to Advanced Configuration to satisfy the lint rule and keep terminology formal.
Suggested fix
-2. Under **Advanced Config**, click **Access Tokens**. +2. Under **Advanced Configuration**, click **Access Tokens**.As per coding guidelines: "In prose, use formal language: write 'configuration' instead of 'config'."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/includes/guides/authentication/passwordless-login/add-passwordless-login-with-hypr.md` at line 55, Replace the informal UI label "Advanced Config" with the formal phrasing "Advanced Configuration" in the sentence that currently reads "Under **Advanced Config**, click **Access Tokens**." — update that exact string occurrence to "Advanced Configuration" so the line becomes "Under **Advanced Configuration**, click **Access Tokens**."en/identity-server/5.11.0/docs/develop/restapis/applications.yaml (1)
733-733:⚠️ Potential issue | 🟡 MinorAdditional spelling issue found: "Permissi on" should be "Permission".
While reviewing the file, noticed a pre-existing typo on line 733 where "Permission" is split as "Permissi on required". Since this PR addresses spelling issues, consider fixing this as well.
✏️ Proposed fix
- <b>Permissi on required:</b> <br> + <b>Permission required:</b> <br>🤖 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/develop/restapis/applications.yaml` at line 733, Fix the typo "Permissi on required:" by removing the stray space so the text reads "Permission required:"; locate the occurrences of the exact string "Permissi on required:" in the applications.yaml content and replace them with "Permission required:" to preserve formatting and markup.en/identity-server/6.0.0/docs/guides/identity-lifecycles/provisioning-patterns.md (1)
45-45:⚠️ Potential issue | 🟡 MinorFix the remaining instances of "Seperator" misspelling.
Lines 45 and 51 still contain "Seperator" which should be "Separator" (with an 'a', not an 'e'). This spelling error appears in the same context as line 52, which was corrected in this PR.
📝 Proposed fix for the remaining misspellings
Line 45:
-identity provider and enter a provisioning pattern and seperator for +identity provider and enter a provisioning pattern and separator forLine 51:
- - **Provisioning Seperator** - This can be a character such as a + - **Provisioning Separator** - This can be a character such as aAs per coding guidelines, run Vale locally to catch all spelling issues before finalizing documentation.
Also applies to: 51-51
🤖 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/guides/identity-lifecycles/provisioning-patterns.md` at line 45, Replace the misspelled term "Seperator" with the correct spelling "Separator" in the documentation—search for the token "Seperator" (the remaining occurrences referenced in the review) and update each instance to "Separator" so it matches the corrected occurrence and passes Vale spell checks.en/identity-server/5.10.0/docs/learn/provisioning-patterns.md (1)
46-46:⚠️ Potential issue | 🟡 MinorFix the remaining instances of "Seperator" misspelling.
Lines 46 and 52 still contain "Seperator" which should be "Separator" (with an 'a', not an 'e'). This spelling error appears in the same context as line 53, which was corrected in this PR.
📝 Proposed fix for the remaining misspellings
Line 46:
-identity provider and enter a provisioning pattern and seperator for +identity provider and enter a provisioning pattern and separator forLine 52:
-- **Provisioning Seperator** - This can be a character such as a +- **Provisioning Separator** - This can be a character such as aAs per coding guidelines, run Vale locally to catch all spelling issues before finalizing documentation.
Also applies to: 52-52
🤖 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/learn/provisioning-patterns.md` at line 46, The document contains remaining misspellings of the word "Seperator" that should be corrected to "Separator"; update every instance (e.g., the occurrences matching the token "Seperator" near the provisioning pattern text and the other occurrence referenced in the diff) to "Separator", search the file en/identity-server/5.10.0/docs/learn/provisioning-patterns.md for any other occurrences and correct them, then run Vale locally to verify no other spelling issues remain.en/identity-server/5.11.0/docs/learn/provisioning-patterns.md (1)
46-46:⚠️ Potential issue | 🟡 MinorFix the remaining instances of "Seperator" misspelling.
Lines 46 and 52 still contain "Seperator" which should be "Separator" (with an 'a', not an 'e'). This spelling error appears in the same context as line 53, which was corrected in this PR.
📝 Proposed fix for the remaining misspellings
Line 46:
-identity provider and enter a provisioning pattern and seperator for +identity provider and enter a provisioning pattern and separator forLine 52:
-- **Provisioning Seperator** - This can be a character such as a +- **Provisioning Separator** - This can be a character such as aAs per coding guidelines, run Vale locally to catch all spelling issues before finalizing documentation.
Also applies to: 52-52
🤖 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/learn/provisioning-patterns.md` at line 46, The documentation contains two remaining misspellings of "Seperator" in the provisioning-patterns.md content: find the literal occurrences of "Seperator" (same context as the already-fixed line 53) and replace them with the correct spelling "Separator"; ensure both instances (the one in the phrase "enter a provisioning pattern and seperator for" and the other at the noted location) are corrected and run Vale locally to confirm no other spelling issues remain.en/identity-server/5.9.0/docs/learn/provisioning-patterns.md (1)
46-46:⚠️ Potential issue | 🟡 MinorFix the remaining instances of "Seperator" misspelling.
Lines 46 and 52 still contain "Seperator" which should be "Separator" (with an 'a', not an 'e'). This spelling error appears in the same context as line 53, which was corrected in this PR.
📝 Proposed fix for the remaining misspellings
Line 46:
-identity provider and enter a provisioning pattern and seperator for +identity provider and enter a provisioning pattern and separator forLine 52:
-- **Provisioning Seperator** - This can be a character such as a +- **Provisioning Separator** - This can be a character such as aAs per coding guidelines, run Vale locally to catch all spelling issues before finalizing documentation.
Also applies to: 52-52
🤖 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/learn/provisioning-patterns.md` at line 46, The document contains remaining misspellings of the word "Seperator" — locate all occurrences of the exact token "Seperator" in the provisioning-patterns.md content (the phrase "enter a provisioning pattern and seperator for" and the other occurrence) and replace them with the correct spelling "Separator"; after fixing, run Vale linting locally to ensure no other spelling issues remain.en/identity-server/6.1.0/docs/guides/identity-lifecycles/provisioning-patterns.md (2)
33-33:⚠️ Potential issue | 🟡 MinorUse "Log in" (verb, two words) instead of "Login".
Lines 33 and 71 use "Login" (single word) as a verb in imperative instructions. Per the established terminology in this repository, use "log in" (two words) as the verb and "login" (single word) only as a noun or adjective. Based on learnings, the repository enforces 'log in' as the verb form consistently across all Markdown documentation.
📝 Proposed fix for correct verb form
Line 33:
-1. Login to the management console using administrator credentials. +1. Log in to the management console using administrator credentials.Line 71:
-5. Login to your already created Salesforce account. O n the left +5. Log in to your already created Salesforce account. On the leftNote: Line 71 also has a spacing issue corrected ("O n" → "On").
Also applies to: 71-71
🤖 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/guides/identity-lifecycles/provisioning-patterns.md` at line 33, Replace the imperative verb "Login" with the two-word verb "Log in" in the sentence "Login to the management console using administrator credentials." and the other occurrence currently written as "Login" (the imperative at line 71), and also correct the spacing typo "O n" to "On" in that same sentence; update both occurrences so the docs use "Log in" as the verb and "On" with normal spacing.
45-45:⚠️ Potential issue | 🟡 MinorIncomplete spelling correction: "seperator" should be "separator".
Lines 45 and 51 still contain the misspelling "seperator", while Line 52 was corrected to use "separate". For consistency and completeness, all instances of this misspelling should be corrected.
📝 Proposed fix for consistent spelling
Line 45:
- identity provider and enter a provisioning pattern and seperator for + identity provider and enter a provisioning pattern and separator forLine 51:
- - **Provisioning Seperator** - This can be a character such as a + - **Provisioning Separator** - This can be a character such as aAlso applies to: 51-51
🤖 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/guides/identity-lifecycles/provisioning-patterns.md` at line 45, Replace the misspelled word "seperator" with the correct spelling "separator" in all occurrences in the document (e.g., the phrase "provisioning pattern and seperator" and any other lines that still use "seperator"); search the file for the token "seperator" and update each instance to "separator" to ensure consistent spelling across the guide.en/identity-server/6.1.0/docs/guides/authorization/mdp-req-and-response.md (1)
27-27:⚠️ Potential issue | 🟡 MinorFix spelling error on line 27: change "instrction" to "instruction".
The word "instrction" is misspelled in the phrase "For detailed instrction on how to install WSO2".
🤖 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/guides/authorization/mdp-req-and-response.md` at line 27, Replace the misspelled word "instrction" with "instruction" in the sentence that reads "For detailed instrction on how to install WSO2" so it becomes "For detailed instruction on how to install WSO2"; locate this exact phrase in the document and update the spelling accordingly.en/identity-server/6.0.0/docs/guides/authorization/mdp-req-and-response.md (1)
27-27:⚠️ Potential issue | 🟡 MinorFix spelling error on line 27: "instrction" should be "instruction".
The word "instrction" in the sentence "WSO2 Identity Server. For detailed instrction on how to install WSO2" is misspelled.
🤖 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/guides/authorization/mdp-req-and-response.md` at line 27, Fix the spelling mistake in the documentation sentence that currently reads "WSO2 Identity Server. For detailed instrction on how to install WSO2" by replacing "instrction" with the correct word "instruction" so the sentence becomes "WSO2 Identity Server. For detailed instruction on how to install WSO2".en/identity-server/5.11.0/docs/develop/scim2-patch-operations.md (1)
477-490:⚠️ Potential issue | 🟡 MinorPlease fix residual wording errors in both example bullets.
Both lines still read as
attribute in attribute, and both usepath param, which Vale already flags. Suggested wording:
Replace the \devices` attribute in the Enterprise user schema (without using the path parameter):`Replace the \devices` attribute in the Enterprise user schema (using the path parameter):`As per coding guidelines, “Use plain language and short sentences” and “Run Vale locally and resolve all warnings before finalizing documentation.”
🤖 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/develop/scim2-patch-operations.md` around lines 477 - 490, Update the two example bullet texts to remove the duplicated phrase "attribute in attribute" and replace "path param" with "path parameter": change "- **Example 1:** Replace the `devices` attribute in attribute in the **Enterprise** user schema (without using the path param):" to "- Replace the `devices` attribute in the **Enterprise** user schema (without using the path parameter):" and similarly change the "**Example 2**" bullet to use "Replace the `devices` attribute in the **Enterprise** user schema (using the path parameter):"; ensure you edit the exact bullet lines for Example 1 and Example 2 in scim2-patch-operations.md.
🧹 Nitpick comments (6)
en/identity-server/5.10.0/docs/learn/configuring-access-delegation-with-oauth2.md (1)
7-7: Consider splitting this sentence for readability.The sentence contains 36 words, exceeding the recommended limit of 30. As per coding guidelines, keep sentences short for better readability.
📝 Proposed refactor to improve readability
-In this sample scenario, a user tries to log in to a vehicle booking web application called "pickup-dispatch" via WSO2 Identity Server and receives an access token to call the API to view the vehicle bookings. +In this sample scenario, a user logs in to a vehicle booking web application called "pickup-dispatch" via WSO2 Identity Server. Upon successful authentication, the user receives an access token to call the API to view the vehicle bookings.🤖 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/learn/configuring-access-delegation-with-oauth2.md` at line 7, The long opening sentence ("In this sample scenario, a user tries to log in to a vehicle booking web application called 'pickup-dispatch' via WSO2 Identity Server and receives an access token to call the API to view the vehicle bookings.") should be split into two shorter sentences for readability; update the text in the doc so it reads something like: "In this sample scenario, a user tries to log in to a vehicle booking web application called 'pickup-dispatch' via WSO2 Identity Server. The user then receives an access token to call the API to view the vehicle bookings." Ensure you edit the same sentence in the OAuth2 configuration doc.en/identity-server/5.11.0/docs/learn/configuring-access-delegation-with-oauth2.md (1)
7-7: Consider splitting this sentence for readability.The sentence contains 36 words, exceeding the recommended limit of 30. As per coding guidelines, keep sentences short for better readability.
📝 Proposed refactor to improve readability
-In this sample scenario, a user tries to log in to a vehicle booking web application called "pickup-dispatch" via WSO2 Identity Server and receives an access token to call the API to view the vehicle bookings. +In this sample scenario, a user logs in to a vehicle booking web application called "pickup-dispatch" via WSO2 Identity Server. Upon successful authentication, the user receives an access token to call the API to view the vehicle bookings.🤖 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/learn/configuring-access-delegation-with-oauth2.md` at line 7, The long opening sentence in configuring-access-delegation-with-oauth2.md should be split into two shorter sentences for readability: break the sentence after "pickup-dispatch" so the first sentence ends with the user logging in via WSO2 Identity Server and the second sentence states that they receive an access token to call the API to view vehicle bookings; update punctuation and capitalization accordingly and ensure the phrase "pickup-dispatch" remains quoted and unchanged.en/identity-server/7.1.0/docs/apis/restapis/script-library.yaml (1)
174-174: Optional: Consider additional grammar improvements.While the spelling corrections in this PR are excellent, there are a couple of additional grammar issues in the unchanged descriptions that could be addressed in a follow-up:
- Line 174: "delete an script library" should be "delete a script library"
- Line 216: "Update a script library of an script library by using name" could be simplified to "Update a script library by using its name"
These same issues appear across all version files.
Also applies to: 216-216
🤖 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/apis/restapis/script-library.yaml` at line 174, Fix two grammar issues in the API descriptions: replace the phrase "delete an script library by giving its name." with "delete a script library by giving its name." (note the article "a" and single space) and simplify "Update a script library of an script library by using name" to "Update a script library by using its name". Apply these exact text replacements for the matching description strings across all versioned YAML files where they appear.en/identity-server/6.0.0/docs/apis/scim2-patch-operations.md (1)
478-478: Consider using lowercase "custom" for consistency.Line 478 uses "Custom" (capitalized) while all other references to custom schemas in this document use "custom" (lowercase) — see lines 282, 299, and 491. For consistency, consider changing "Custom" to "custom" since it's an adjective, not a proper noun.
Suggested change for consistency
-- **Example 1:** Replace the `devices` attribute in a **Custom** user schema (without using the path param): +- **Example 1:** Replace the `devices` attribute in a **custom** user schema (without using the path param):🤖 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/apis/scim2-patch-operations.md` at line 478, The term "**Custom**" in the heading "Example 1: Replace the `devices` attribute in a **Custom** user schema (without using the path param)" should be changed to lowercase "**custom**" to match other occurrences in the document; update that heading text (the "Example 1" line referencing the `devices` attribute) so it reads "custom" instead of "Custom" for consistency with the uses at lines referencing the custom schema elsewhere.en/identity-server/next/docs/apis/scim2-patch-operations.md (1)
478-478: Consider using lowercase "custom" for consistency.Line 478 uses "Custom" (capitalized) while all other references to custom schemas in this document use "custom" (lowercase) — see lines 282, 299, and 491. For consistency, consider changing "Custom" to "custom" since it's an adjective, not a proper noun.
Suggested change for consistency
-- **Example 1:** Replace the `devices` attribute in a **Custom** user schema (without using the path param): +- **Example 1:** Replace the `devices` attribute in a **custom** user schema (without using the path param):🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@en/identity-server/next/docs/apis/scim2-patch-operations.md` at line 478, Change the capitalized "Custom" to lowercase "custom" in the example heading and sentence that reads "**Example 1:** Replace the `devices` attribute in a **Custom** user schema (without using the path param)" so it matches other occurrences (e.g., lines referencing "**custom**"); update that exact phrase to "**custom**" to maintain consistent adjective casing across the document.en/identity-server/5.10.0/docs/learn/fine-grained-authorization-using-xacml-requests-in-json-format.md (1)
11-14: Consider shortening the sentence.The sentence spanning lines 11-14 contains 34 words, which exceeds the recommended 30-word limit. While this is a pre-existing issue (not introduced by this PR), consider breaking it into two shorter sentences for improved readability.
✍️ Proposed refactor for improved readability
-Consider a sample scenario where a user requests authorization to a -resource registered in WSO2 IS. When WSO2 IS receives the request, an -enforced policy will be evaluated and the Policy Decision Point (PDP) in -WSO2 Identity Server decides whether or not to grant the user access to -the resource. +Consider a sample scenario where a user requests authorization to a +resource registered in WSO2 IS. When WSO2 IS receives the request, an +enforced policy is evaluated. The Policy Decision Point (PDP) in +WSO2 Identity Server then decides whether to grant the user access to +the resource.As per coding guidelines: "Use plain language and short sentences" and "Try to keep sentences short (< 30 words)".
🤖 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/learn/fine-grained-authorization-using-xacml-requests-in-json-format.md` around lines 11 - 14, The long sentence describing policy evaluation and PDP decision should be split into two shorter sentences to meet the <30-word guideline; change the sentence that begins "resource registered in WSO2 IS." into two sentences—e.g., end the first sentence after "request." and start the second with "When WSO2 IS receives the request, an enforced policy is evaluated; the Policy Decision Point (PDP) then decides whether to grant the user access to the resource."—so the text in the paragraph that mentions the Policy Decision Point (PDP) and policy evaluation becomes two concise sentences for improved readability.
🤖 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/develop/writing-a-post-authentication-handler.md`:
- Line 78: Split the long sentence that begins "If a response from an external
page is submitted to the post-authentication handler which is in progress, the
following needs to be included in the request along with the input data that is
received from the external page:" into two concise sentences for clarity and
readability: first state the condition ("If a response from an external page is
submitted to the post-authentication handler while it is in progress.") and then
state the requirement ("Include the following in the request along with the
input data received from the external page:"). Keep both sentences short and
plain.
In `@en/identity-server/5.10.0/docs/setup/http-access-logging.md`:
- Around line 8-9: The sentence "access logs for the servlet transport is useful
for analysing operational/admin-level access" has subject-verb agreement and
phrasing issues; change "is" to "are" and simplify the transition for
conciseness (e.g., "access logs for the servlet transport are useful for
analysing operational and admin-level access."). Locate the sentence containing
the fragment "access logs for the servlet transport is useful" and update it to
use the plural verb and clearer wording.
In
`@en/identity-server/5.10.0/docs/setup/setting-up-separate-databases-for-clustering.md`:
- Around line 58-59: Replace the misspelled word "deplyment" with "deployment"
in the affected documentation lines (the two occurrences shown in the diff),
ensuring both instances are fixed so Vale warnings are resolved; verify the
change in the file "setting-up-separate-databases-for-clustering.md" where the
phrase appears describing separation of identity/UMA and CONSENT_MGT database.
In `@en/identity-server/5.11.0/docs/develop/restapis/scim2.yaml`:
- Line 1374: The bulk PATCH description contains a spelling typo: change the
text fragment "- **PATCH** opearation: Updates attributes of an existing
resource." to use "operation" (i.e., "- **PATCH** operation: Updates attributes
of an existing resource.") so the word "opearation" is corrected to "operation"
in the SCIM2 bulk PATCH description.
In
`@en/identity-server/5.11.0/docs/develop/writing-a-post-authentication-handler.md`:
- Line 78: The long sentence describing required request fields for a
post-authentication handler should be split into two short, clear sentences:
first state that when an external page submits a response to a
post-authentication handler that is already in progress, additional request
fields are required; second list that these fields must be included along with
the input data received from the external page. Update the paragraph around the
current sentence in writing-a-post-authentication-handler.md to use two concise
sentences for clarity and scanning.
In
`@en/identity-server/5.11.0/docs/setup/setting-up-separate-databases-for-clustering.md`:
- Around line 58-59: The document contains the misspelling "deplyment"
(appearing twice) — replace every occurrence of "deplyment" with the correct
spelling "deployment" in this markdown (including the instances noted near the
sentences about separating identity/UMA and CONSENT_MGT and the other occurrence
referenced), then run Vale locally to ensure no further spelling warnings remain
before finalizing the change.
In
`@en/identity-server/5.9.0/docs/develop/writing-a-post-authentication-handler.md`:
- Line 78: Split the long sentence that mentions "If a response from an external
page is submitted to the post-authentication handler which is in progress, the
following needs to be included in the request along with the input data that is
received from the external page:" into two short sentences for clarity: first
state that when a response from an external page is submitted to a
post-authentication handler that is already in progress, certain information
must be included in the request; second list that the request must include that
information plus the input data received from the external page. Keep
"post-authentication handler" and "input data from the external page" wording to
match existing terminology.
In `@en/identity-server/5.9.0/docs/setup/http-access-logging.md`:
- Line 9: The sentence "servlet transport is useful for analysing
operational/admin-level access" has a subject-verb agreement error because
"access logs" (implied plural) requires "are"; update the sentence to read
"servlet transport are useful for analysing operational/admin-level access logs"
(or better: "servlet transport is useful for analysing operational/admin-level
access" -> "servlet transport is useful for analysing operational/admin-level
access logs" by making "access" explicit and keeping "is" only if you change the
noun to singular) — replace the original sentence exactly with the corrected
plural form so the grammar matches the plural noun.
In
`@en/identity-server/5.9.0/docs/setup/setting-up-separate-databases-for-clustering.md`:
- Around line 58-59: Replace the misspelled word "deplyment" with "deployment"
in the document setting-up-separate-databases-for-clustering.md wherever it
appears (specifically the occurrences shown in the diff and the additional ones
around the later paragraph), ensuring both sentences read "deployment" and then
run Vale/local spellcheck to confirm no remaining spelling warnings.
In `@en/identity-server/6.0.0/docs/apis/restapis/scim2.yaml`:
- Line 1204: Fix the typo in the /Bulk endpoint description: change the bullet
text "**PATCH** opearation: Updates attributes of an existing resource." to
"**PATCH** operation: Updates attributes of an existing resource." — locate the
PATCH bullet in the /Bulk endpoint section of scim2.yaml (search for the
"**PATCH** opearation" string) and correct "opearation" to "operation".
In
`@en/identity-server/6.0.0/docs/guides/login/log-into-office365-using-ws-trust.md`:
- Line 74: The sentence contains a missing space after the period in the
fragment "default.Therefore" (and already-corrected "recieve" -> "receive");
update the text so the fragment reads "default. Therefore" to fix the spacing in
the document (search for the string "default.Therefore" to locate the
paragraph).
In `@en/identity-server/6.1.0/docs/apis/restapis/scim2.yaml`:
- Line 1204: Fix the typo in the PATCH description in the scim2.yaml by
replacing "opearation" with "operation" in the line that reads "- **PATCH**
opearation: Updates attributes of an existing resource." so the description
becomes "- **PATCH** operation: Updates attributes of an existing resource.";
locate and update the PATCH description string in the SCIM2 API docs
(scim2.yaml) accordingly.
In
`@en/identity-server/6.1.0/docs/deploy/set-up-separate-databases-for-clustering.md`:
- Line 59: Update the list item that currently contains "database
`CONSENT_MGT`</li>." so the sentence-ending period is placed before the closing
</li> tag and replace the backtick-wrapped CONSENT_MGT with an HTML
<code>CONSENT_MGT</code> tag to match other database name formatting; locate the
list element in the same block that contains the text "database `CONSENT_MGT`"
and apply these two edits together.
In
`@en/identity-server/6.1.0/docs/guides/login/log-into-office365-using-ws-trust.md`:
- Line 74: Update the sentence that begins "These attributes are not supported
by Active Directory by default.Therefore..." in the
log-into-office365-using-ws-trust.md document: add a space after the period so
it reads "default. Therefore" and ensure the word "receive" is spelled correctly
(replace any "recieve" occurrences). Save the corrected sentence so it reads:
"These attributes are not supported by Active Directory by default. Therefore,
if these attributes are ticked as **Supported by Default** in Identity Server,
they will be shown in the default user profile and you will receive an error
once you try to update the user profile."
In `@en/includes/complete-guides/dotnet/protected-api.md`:
- Line 253: The Console.WriteLine call that logs the protected API error
currently splits the sentence ("API. received ..."); update the message in the
Console.WriteLine that references response.StatusCode to be a single clear
sentence using plain language (e.g., combine into one sentence like "Error
invoking protected API: received an unsuccessful response (StatusCode: ...)" or
similar), ensuring proper capitalization and including response.StatusCode for
context.
---
Outside diff comments:
In `@en/identity-server/5.10.0/docs/learn/provisioning-patterns.md`:
- Line 46: The document contains remaining misspellings of the word "Seperator"
that should be corrected to "Separator"; update every instance (e.g., the
occurrences matching the token "Seperator" near the provisioning pattern text
and the other occurrence referenced in the diff) to "Separator", search the file
en/identity-server/5.10.0/docs/learn/provisioning-patterns.md for any other
occurrences and correct them, then run Vale locally to verify no other spelling
issues remain.
In `@en/identity-server/5.11.0/docs/develop/restapis/applications.yaml`:
- Line 733: Fix the typo "Permissi on required:" by removing the stray space so
the text reads "Permission required:"; locate the occurrences of the exact
string "Permissi on required:" in the applications.yaml content and replace them
with "Permission required:" to preserve formatting and markup.
In `@en/identity-server/5.11.0/docs/develop/scim2-patch-operations.md`:
- Around line 477-490: Update the two example bullet texts to remove the
duplicated phrase "attribute in attribute" and replace "path param" with "path
parameter": change "- **Example 1:** Replace the `devices` attribute in
attribute in the **Enterprise** user schema (without using the path param):" to
"- Replace the `devices` attribute in the **Enterprise** user schema (without
using the path parameter):" and similarly change the "**Example 2**" bullet to
use "Replace the `devices` attribute in the **Enterprise** user schema (using
the path parameter):"; ensure you edit the exact bullet lines for Example 1 and
Example 2 in scim2-patch-operations.md.
In `@en/identity-server/5.11.0/docs/learn/provisioning-patterns.md`:
- Line 46: The documentation contains two remaining misspellings of "Seperator"
in the provisioning-patterns.md content: find the literal occurrences of
"Seperator" (same context as the already-fixed line 53) and replace them with
the correct spelling "Separator"; ensure both instances (the one in the phrase
"enter a provisioning pattern and seperator for" and the other at the noted
location) are corrected and run Vale locally to confirm no other spelling issues
remain.
In `@en/identity-server/5.9.0/docs/learn/provisioning-patterns.md`:
- Line 46: The document contains remaining misspellings of the word "Seperator"
— locate all occurrences of the exact token "Seperator" in the
provisioning-patterns.md content (the phrase "enter a provisioning pattern and
seperator for" and the other occurrence) and replace them with the correct
spelling "Separator"; after fixing, run Vale linting locally to ensure no other
spelling issues remain.
In `@en/identity-server/6.0.0/docs/guides/authorization/mdp-req-and-response.md`:
- Line 27: Fix the spelling mistake in the documentation sentence that currently
reads "WSO2 Identity Server. For detailed instrction on how to install WSO2" by
replacing "instrction" with the correct word "instruction" so the sentence
becomes "WSO2 Identity Server. For detailed instruction on how to install WSO2".
In
`@en/identity-server/6.0.0/docs/guides/identity-lifecycles/provisioning-patterns.md`:
- Line 45: Replace the misspelled term "Seperator" with the correct spelling
"Separator" in the documentation—search for the token "Seperator" (the remaining
occurrences referenced in the review) and update each instance to "Separator" so
it matches the corrected occurrence and passes Vale spell checks.
In `@en/identity-server/6.1.0/docs/guides/authorization/mdp-req-and-response.md`:
- Line 27: Replace the misspelled word "instrction" with "instruction" in the
sentence that reads "For detailed instrction on how to install WSO2" so it
becomes "For detailed instruction on how to install WSO2"; locate this exact
phrase in the document and update the spelling accordingly.
In
`@en/identity-server/6.1.0/docs/guides/identity-lifecycles/provisioning-patterns.md`:
- Line 33: Replace the imperative verb "Login" with the two-word verb "Log in"
in the sentence "Login to the management console using administrator
credentials." and the other occurrence currently written as "Login" (the
imperative at line 71), and also correct the spacing typo "O n" to "On" in that
same sentence; update both occurrences so the docs use "Log in" as the verb and
"On" with normal spacing.
- Line 45: Replace the misspelled word "seperator" with the correct spelling
"separator" in all occurrences in the document (e.g., the phrase "provisioning
pattern and seperator" and any other lines that still use "seperator"); search
the file for the token "seperator" and update each instance to "separator" to
ensure consistent spelling across the guide.
In
`@en/includes/guides/authentication/passwordless-login/add-passwordless-login-with-hypr.md`:
- Line 55: Replace the informal UI label "Advanced Config" with the formal
phrasing "Advanced Configuration" in the sentence that currently reads "Under
**Advanced Config**, click **Access Tokens**." — update that exact string
occurrence to "Advanced Configuration" so the line becomes "Under **Advanced
Configuration**, click **Access Tokens**."
---
Nitpick comments:
In
`@en/identity-server/5.10.0/docs/learn/configuring-access-delegation-with-oauth2.md`:
- Line 7: The long opening sentence ("In this sample scenario, a user tries to
log in to a vehicle booking web application called 'pickup-dispatch' via WSO2
Identity Server and receives an access token to call the API to view the vehicle
bookings.") should be split into two shorter sentences for readability; update
the text in the doc so it reads something like: "In this sample scenario, a user
tries to log in to a vehicle booking web application called 'pickup-dispatch'
via WSO2 Identity Server. The user then receives an access token to call the API
to view the vehicle bookings." Ensure you edit the same sentence in the OAuth2
configuration doc.
In
`@en/identity-server/5.10.0/docs/learn/fine-grained-authorization-using-xacml-requests-in-json-format.md`:
- Around line 11-14: The long sentence describing policy evaluation and PDP
decision should be split into two shorter sentences to meet the <30-word
guideline; change the sentence that begins "resource registered in WSO2 IS."
into two sentences—e.g., end the first sentence after "request." and start the
second with "When WSO2 IS receives the request, an enforced policy is evaluated;
the Policy Decision Point (PDP) then decides whether to grant the user access to
the resource."—so the text in the paragraph that mentions the Policy Decision
Point (PDP) and policy evaluation becomes two concise sentences for improved
readability.
In
`@en/identity-server/5.11.0/docs/learn/configuring-access-delegation-with-oauth2.md`:
- Line 7: The long opening sentence in
configuring-access-delegation-with-oauth2.md should be split into two shorter
sentences for readability: break the sentence after "pickup-dispatch" so the
first sentence ends with the user logging in via WSO2 Identity Server and the
second sentence states that they receive an access token to call the API to view
vehicle bookings; update punctuation and capitalization accordingly and ensure
the phrase "pickup-dispatch" remains quoted and unchanged.
In `@en/identity-server/6.0.0/docs/apis/scim2-patch-operations.md`:
- Line 478: The term "**Custom**" in the heading "Example 1: Replace the
`devices` attribute in a **Custom** user schema (without using the path param)"
should be changed to lowercase "**custom**" to match other occurrences in the
document; update that heading text (the "Example 1" line referencing the
`devices` attribute) so it reads "custom" instead of "Custom" for consistency
with the uses at lines referencing the custom schema elsewhere.
In `@en/identity-server/7.1.0/docs/apis/restapis/script-library.yaml`:
- Line 174: Fix two grammar issues in the API descriptions: replace the phrase
"delete an script library by giving its name." with "delete a script library by
giving its name." (note the article "a" and single space) and simplify "Update a
script library of an script library by using name" to "Update a script library
by using its name". Apply these exact text replacements for the matching
description strings across all versioned YAML files where they appear.
In `@en/identity-server/next/docs/apis/scim2-patch-operations.md`:
- Line 478: Change the capitalized "Custom" to lowercase "custom" in the example
heading and sentence that reads "**Example 1:** Replace the `devices` attribute
in a **Custom** user schema (without using the path param)" so it matches other
occurrences (e.g., lines referencing "**custom**"); update that exact phrase to
"**custom**" to maintain consistent adjective casing across the document.
🪄 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: e32312a8-f69e-460c-9a6d-4f58737a792a
📒 Files selected for processing (146)
en/asgardeo/docs/apis/organization-apis/restapis/org-application-mgt.yamlen/asgardeo/docs/apis/restapis/application-management.yamlen/asgardeo/docs/apis/restapis/consent-management.yamlen/asgardeo/docs/get-started/try-samples/ws-federation-webapp.mden/asgardeo/docs/guides/users/manage-users.mden/asgardeo/docs/guides/users/user-stores/configure-high-availability.mden/asgardeo/docs/guides/your-asgardeo/subscribe-to-asgardeo/subscribe-via-azure-marketplace.mden/identity-server/5.10.0/docs/administer/data-dictionary.mden/identity-server/5.10.0/docs/administer/identity-related-tables.mden/identity-server/5.10.0/docs/develop/restapis/account-recovery-v0.9.yamlen/identity-server/5.10.0/docs/develop/restapis/applications.yamlen/identity-server/5.10.0/docs/develop/writing-a-post-authentication-handler.mden/identity-server/5.10.0/docs/learn/configuring-access-delegation-with-oauth2.mden/identity-server/5.10.0/docs/learn/fine-grained-authorization-using-xacml-requests-in-json-format.mden/identity-server/5.10.0/docs/learn/logging-in-to-office365-with-ws-trust.mden/identity-server/5.10.0/docs/learn/provisioning-patterns.mden/identity-server/5.10.0/docs/learn/sending-notifications-to-external-pep-endpoints.mden/identity-server/5.10.0/docs/learn/working-with-mdp-requests-in-json-format.mden/identity-server/5.10.0/docs/learn/xacml-sample-for-an-online-trading-application.mden/identity-server/5.10.0/docs/references/error-catalog.mden/identity-server/5.10.0/docs/setup/http-access-logging.mden/identity-server/5.10.0/docs/setup/monitoring-server-health.mden/identity-server/5.10.0/docs/setup/setting-up-separate-databases-for-clustering.mden/identity-server/5.11.0/docs/administer/data-dictionary.mden/identity-server/5.11.0/docs/administer/identity-related-tables.mden/identity-server/5.11.0/docs/develop/restapis/account-recovery-v0.9.yamlen/identity-server/5.11.0/docs/develop/restapis/applications.yamlen/identity-server/5.11.0/docs/develop/restapis/scim2.yamlen/identity-server/5.11.0/docs/develop/scim2-patch-operations.mden/identity-server/5.11.0/docs/develop/writing-a-post-authentication-handler.mden/identity-server/5.11.0/docs/learn/configuring-access-delegation-with-oauth2.mden/identity-server/5.11.0/docs/learn/fine-grained-authorization-using-xacml-requests-in-json-format.mden/identity-server/5.11.0/docs/learn/logging-in-to-office365-with-ws-trust.mden/identity-server/5.11.0/docs/learn/provisioning-patterns.mden/identity-server/5.11.0/docs/learn/sending-notifications-to-external-pep-endpoints.mden/identity-server/5.11.0/docs/learn/working-with-mdp-requests-in-json-format.mden/identity-server/5.11.0/docs/learn/xacml-sample-for-an-online-trading-application.mden/identity-server/5.11.0/docs/references/error-catalog.mden/identity-server/5.11.0/docs/setup/http-access-logging.mden/identity-server/5.11.0/docs/setup/monitoring-server-health.mden/identity-server/5.11.0/docs/setup/setting-up-separate-databases-for-clustering.mden/identity-server/5.9.0/docs/administer/data-dictionary.mden/identity-server/5.9.0/docs/administer/identity-related-tables.mden/identity-server/5.9.0/docs/develop/using-the-scim-2.0-rest-apis.mden/identity-server/5.9.0/docs/develop/writing-a-post-authentication-handler.mden/identity-server/5.9.0/docs/learn/configuring-access-delegation-with-oauth2.mden/identity-server/5.9.0/docs/learn/fine-grained-authorization-using-xacml-requests-in-json-format.mden/identity-server/5.9.0/docs/learn/logging-in-to-office365-with-ws-trust.mden/identity-server/5.9.0/docs/learn/provisioning-patterns.mden/identity-server/5.9.0/docs/learn/sending-notifications-to-external-pep-endpoints.mden/identity-server/5.9.0/docs/learn/user-registration-with-password-entry.mden/identity-server/5.9.0/docs/learn/working-with-mdp-requests-in-json-format.mden/identity-server/5.9.0/docs/learn/xacml-sample-for-an-online-trading-application.mden/identity-server/5.9.0/docs/setup/http-access-logging.mden/identity-server/5.9.0/docs/setup/monitoring-server-health.mden/identity-server/5.9.0/docs/setup/setting-up-separate-databases-for-clustering.mden/identity-server/6.0.0/docs/apis/restapis/account-recovery.yamlen/identity-server/6.0.0/docs/apis/restapis/application.yamlen/identity-server/6.0.0/docs/apis/restapis/scim2.yamlen/identity-server/6.0.0/docs/apis/restapis/script-library.yamlen/identity-server/6.0.0/docs/apis/scim2-patch-operations.mden/identity-server/6.0.0/docs/deploy/configure-recaptcha.mden/identity-server/6.0.0/docs/deploy/ext-pep-endpoint-notifications.mden/identity-server/6.0.0/docs/deploy/monitor/http-access-logging.mden/identity-server/6.0.0/docs/deploy/monitor/monitor-server-health.mden/identity-server/6.0.0/docs/deploy/set-up-separate-databases-for-clustering.mden/identity-server/6.0.0/docs/guides/access-delegation/get-user-claims-as-a-jwt.mden/identity-server/6.0.0/docs/guides/authorization/fine-grained-auth-json.mden/identity-server/6.0.0/docs/guides/authorization/mdp-req-and-response.mden/identity-server/6.0.0/docs/guides/identity-lifecycles/provisioning-patterns.mden/identity-server/6.0.0/docs/guides/login/log-into-office365-using-ws-trust.mden/identity-server/6.0.0/docs/guides/login/oidc-token-encryption.mden/identity-server/6.0.0/docs/guides/tenants/user-operation-notifications.mden/identity-server/6.0.0/docs/includes/set-up-recaptcha.mden/identity-server/6.0.0/docs/references/concepts/authentication/hybrid-client-profile.mden/identity-server/6.0.0/docs/references/error-catalog.mden/identity-server/6.1.0/docs/apis/restapis/account-recovery.yamlen/identity-server/6.1.0/docs/apis/restapis/application.yamlen/identity-server/6.1.0/docs/apis/restapis/scim2.yamlen/identity-server/6.1.0/docs/apis/restapis/script-library.yamlen/identity-server/6.1.0/docs/apis/scim2-patch-operations.mden/identity-server/6.1.0/docs/deploy/configure-recaptcha.mden/identity-server/6.1.0/docs/deploy/ext-pep-endpoint-notifications.mden/identity-server/6.1.0/docs/deploy/monitor/http-access-logging.mden/identity-server/6.1.0/docs/deploy/monitor/monitor-server-health.mden/identity-server/6.1.0/docs/deploy/set-up-separate-databases-for-clustering.mden/identity-server/6.1.0/docs/guides/access-delegation/get-user-claims-as-a-jwt.mden/identity-server/6.1.0/docs/guides/authorization/fine-grained-auth-json.mden/identity-server/6.1.0/docs/guides/authorization/mdp-req-and-response.mden/identity-server/6.1.0/docs/guides/identity-lifecycles/provisioning-patterns.mden/identity-server/6.1.0/docs/guides/login/log-into-office365-using-ws-trust.mden/identity-server/6.1.0/docs/guides/login/multi-attribute-login.mden/identity-server/6.1.0/docs/guides/login/oidc-token-encryption.mden/identity-server/6.1.0/docs/guides/tenants/user-operation-notifications.mden/identity-server/6.1.0/docs/includes/set-up-recaptcha.mden/identity-server/6.1.0/docs/references/concepts/authentication/hybrid-client-profile.mden/identity-server/6.1.0/docs/references/error-catalog.mden/identity-server/7.0.0/docs/apis/organization-apis/restapis/application.yamlen/identity-server/7.0.0/docs/apis/restapis/application.yamlen/identity-server/7.0.0/docs/apis/restapis/consent-management.yamlen/identity-server/7.0.0/docs/apis/restapis/identity-governance.yamlen/identity-server/7.0.0/docs/apis/restapis/script-library.yamlen/identity-server/7.0.0/docs/apis/scim2/scim2-patch-operations.mden/identity-server/7.0.0/docs/deploy/security/configure-transport-level-security.mden/identity-server/7.0.0/docs/references/troubleshoot/api-error-codes.mden/identity-server/7.1.0/docs/apis/organization-apis/restapis/application.yamlen/identity-server/7.1.0/docs/apis/organization-apis/restapis/org-application-mgt.yamlen/identity-server/7.1.0/docs/apis/restapis/application.yamlen/identity-server/7.1.0/docs/apis/restapis/consent-management.yamlen/identity-server/7.1.0/docs/apis/restapis/identity-governance.yamlen/identity-server/7.1.0/docs/apis/restapis/script-library.yamlen/identity-server/7.1.0/docs/apis/scim2-patch-operations.mden/identity-server/7.1.0/docs/apis/scim2/scim2-patch-operations.mden/identity-server/7.1.0/docs/deploy/security/configure-transport-level-security.mden/identity-server/7.1.0/docs/references/troubleshoot/api-error-codes.mden/identity-server/7.2.0/docs/apis/organization-apis/restapis/application.yamlen/identity-server/7.2.0/docs/apis/organization-apis/restapis/identity-governance.yamlen/identity-server/7.2.0/docs/apis/organization-apis/restapis/org-application-mgt.yamlen/identity-server/7.2.0/docs/apis/restapis/application.yamlen/identity-server/7.2.0/docs/apis/restapis/consent-management.yamlen/identity-server/7.2.0/docs/apis/restapis/identity-governance.yamlen/identity-server/7.2.0/docs/apis/restapis/script-library.yamlen/identity-server/7.2.0/docs/apis/scim2-patch-operations.mden/identity-server/7.2.0/docs/apis/scim2/scim2-patch-operations.mden/identity-server/7.2.0/docs/deploy/security/configure-transport-level-security.mden/identity-server/7.2.0/docs/references/troubleshoot/api-error-codes.mden/identity-server/next/docs/apis/organization-apis/restapis/application.yamlen/identity-server/next/docs/apis/organization-apis/restapis/identity-governance.yamlen/identity-server/next/docs/apis/organization-apis/restapis/org-application-mgt.yamlen/identity-server/next/docs/apis/restapis/application.yamlen/identity-server/next/docs/apis/restapis/consent-management.yamlen/identity-server/next/docs/apis/restapis/identity-governance.yamlen/identity-server/next/docs/apis/restapis/script-library.yamlen/identity-server/next/docs/apis/scim2-patch-operations.mden/identity-server/next/docs/deploy/security/configure-transport-level-security.mden/identity-server/next/docs/references/troubleshoot/api-error-codes.mden/includes/apis/scim2/scim2-patch-operations.mden/includes/complete-guides/dotnet/protected-api.mden/includes/connectors/sift-v2/usage.mden/includes/connectors/sift/usage.mden/includes/get-started/try-samples/ws-federation-webapp.mden/includes/guides/account-configurations/account-recovery/password-recovery.mden/includes/guides/account-configurations/login-security/sift-fraud-detection.mden/includes/guides/authentication/mfa/add-push-auth-login.mden/includes/guides/authentication/passwordless-login/add-passwordless-login-with-hypr.mden/includes/guides/authentication/passwordless-login/add-passwordless-login-with-push-notification.md
| <td>INCOMPLETE</td> | ||
| <td><p>This status indicates that the post-authentication process is incomplete (e.g., a redirection to an external page). The response can be simply redirected and you can expect it to come back to your post-authentication handler once the response is submitted to WSO2 IS again.</p> | ||
| <p>If a response from an external page is submitted to the post-authentication handler which is in progress, the following needs to be included in the request along with the input data that is recieved from the external page:</p> | ||
| <p>If a response from an external page is submitted to the post-authentication handler which is in progress, the following needs to be included in the request along with the input data that is received from the external page:</p> |
Contributor
There was a problem hiding this comment.
Split this long sentence for clarity and style compliance.
Line 78 is still too long and hard to scan. Split it into shorter, direct sentences.
✍️ Suggested rewrite
-<p>If a response from an external page is submitted to the post-authentication handler which is in progress, the following needs to be included in the request along with the input data that is received from the external page:</p>
+<p>If an external page submits a response while the post-authentication handler is in progress, include the following in the request. Include these values with the input data received from the external page:</p>📝 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
| <p>If a response from an external page is submitted to the post-authentication handler which is in progress, the following needs to be included in the request along with the input data that is received from the external page:</p> | |
| <p>If an external page submits a response while the post-authentication handler is in progress, include the following in the request. Include these values with the input data received from the external page:</p> |
🧰 Tools
🪛 GitHub Check: Vale style check
[warning] 78-78:
[vale] reported by reviewdog 🐶
[WSO2-IAM.SentenceLength] Try to keep sentences short (< 30 words).
Raw Output:
{"message": "[WSO2-IAM.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "en/identity-server/5.10.0/docs/develop/writing-a-post-authentication-handler.md", "range": {"start": {"line": 78, "column": 4}}}, "severity": "INFO"}
🤖 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/develop/writing-a-post-authentication-handler.md`
at line 78, Split the long sentence that begins "If a response from an external
page is submitted to the post-authentication handler which is in progress, the
following needs to be included in the request along with the input data that is
received from the external page:" into two concise sentences for clarity and
readability: first state the condition ("If a response from an external page is
submitted to the post-authentication handler while it is in progress.") and then
state the requirement ("Include the following in the request along with the
input data received from the external page:"). Keep both sentences short and
plain.
Comment on lines
+8
to
+9
| and it receives admin/operation requests. Therefore, access logs for the | ||
| servlet transport is useful for analysing operational/admin-level access |
Contributor
There was a problem hiding this comment.
Fix subject-verb agreement in the updated sentence.
Line 9 should use a plural verb: “access logs … are useful.” You can also simplify the transition to keep the sentence concise.
✏️ Proposed wording
-and it receives admin/operation requests. Therefore, access logs for the
-servlet transport is useful for analysing operational/admin-level access
+and it receives admin/operation requests. Access logs for the
+servlet transport are useful for analyzing operational/admin-level access
details.As per coding guidelines, “Use plain language and short sentences.”
🧰 Tools
🪛 GitHub Check: Vale style check
[warning] 9-9:
[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'servlet'?
Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'servlet'?", "location": {"path": "en/identity-server/5.10.0/docs/setup/http-access-logging.md", "range": {"start": {"line": 9, "column": 1}}}, "severity": "WARNING"}
[warning] 8-8:
[vale] reported by reviewdog 🐶
[WSO2-IAM.TooWordy] 'Therefore' is too wordy.
Raw Output:
{"message": "[WSO2-IAM.TooWordy] 'Therefore' is too wordy.", "location": {"path": "en/identity-server/5.10.0/docs/setup/http-access-logging.md", "range": {"start": {"line": 8, "column": 43}}}, "severity": "WARNING"}
🤖 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/setup/http-access-logging.md` around lines 8 -
9, The sentence "access logs for the servlet transport is useful for analysing
operational/admin-level access" has subject-verb agreement and phrasing issues;
change "is" to "are" and simplify the transition for conciseness (e.g., "access
logs for the servlet transport are useful for analysing operational and
admin-level access."). Locate the sentence containing the fragment "access logs
for the servlet transport is useful" and update it to use the plural verb and
clearer wording.
Comment on lines
+58
to
59
| In a deplyment both identity and UMA can be separated for a single database while consent data is configured to a separate | ||
| database `CONSENT_MGT`</li> |
Contributor
There was a problem hiding this comment.
Vale warning is valid: deplyment is misspelled in both edited lines.
Please replace deplyment with deployment at both locations (Line 58 and Line 88).
Proposed fix
- In a deplyment both identity and UMA can be separated for a single database while consent data is configured to a separate
+ In a deployment both identity and UMA can be separated for a single database while consent data is configured to a separate
...
- In a deplyment both identity and UMA can be separated for a single database while consent data is configured to a separate
+ In a deployment both identity and UMA can be separated for a single database while consent data is configured to a separate As per coding guidelines: "Run Vale locally and resolve all warnings before finalizing documentation; if Vale flags a word as a spelling error... fix the spelling."
Also applies to: 88-89
🧰 Tools
🪛 GitHub Check: Vale style check
[warning] 58-58:
[vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'deplyment'?
Raw Output:
{"message": "[Vale.Spelling] Did you really mean 'deplyment'?", "location": {"path": "en/identity-server/5.10.0/docs/setup/setting-up-separate-databases-for-clustering.md", "range": {"start": {"line": 58, "column": 7}}}, "severity": "WARNING"}
🤖 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/setup/setting-up-separate-databases-for-clustering.md`
around lines 58 - 59, Replace the misspelled word "deplyment" with "deployment"
in the affected documentation lines (the two occurrences shown in the diff),
ensuring both instances are fixed so Vale warnings are resolved; verify the
change in the file "setting-up-separate-databases-for-clustering.md" where the
phrase appears describing separation of identity/UMA and CONSENT_MGT database.
| - **POST** operation: Adds new resources. | ||
| - **PUT** operation: Replaces an existing resource. | ||
| - **PATCH** opearation: Updates attribues of an existing resource. | ||
| - **PATCH** opearation: Updates attributes of an existing resource. |
Contributor
There was a problem hiding this comment.
Patch bullet still has a spelling typo.
Please change opearation to operation in the bulk PATCH description.
Suggested fix
- - **PATCH** opearation: Updates attributes of an existing resource.
+ - **PATCH** operation: Updates attributes of an existing resource.📝 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
| - **PATCH** opearation: Updates attributes of an existing resource. | |
| - **PATCH** operation: Updates attributes of an existing resource. |
🤖 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/develop/restapis/scim2.yaml` at line 1374, The
bulk PATCH description contains a spelling typo: change the text fragment "-
**PATCH** opearation: Updates attributes of an existing resource." to use
"operation" (i.e., "- **PATCH** operation: Updates attributes of an existing
resource.") so the word "opearation" is corrected to "operation" in the SCIM2
bulk PATCH description.
| <td>INCOMPLETE</td> | ||
| <td><p>This status indicates that the post-authentication process is incomplete (e.g., a redirection to an external page). The response can be simply redirected and you can expect it to come back to your post-authentication handler once the response is submitted to WSO2 IS again.</p> | ||
| <p>If a response from an external page is submitted to the post-authentication handler which is in progress, the following needs to be included in the request along with the input data that is recieved from the external page:</p> | ||
| <p>If a response from an external page is submitted to the post-authentication handler which is in progress, the following needs to be included in the request along with the input data that is received from the external page:</p> |
Contributor
There was a problem hiding this comment.
Split this long sentence for clarity and style compliance.
Line 78 is still too long and hard to scan. Split it into shorter, direct sentences.
✍️ Suggested rewrite
-<p>If a response from an external page is submitted to the post-authentication handler which is in progress, the following needs to be included in the request along with the input data that is received from the external page:</p>
+<p>If an external page submits a response while the post-authentication handler is in progress, include the following in the request. Include these values with the input data received from the external page:</p>📝 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
| <p>If a response from an external page is submitted to the post-authentication handler which is in progress, the following needs to be included in the request along with the input data that is received from the external page:</p> | |
| <p>If an external page submits a response while the post-authentication handler is in progress, include the following in the request. Include these values with the input data received from the external page:</p> |
🧰 Tools
🪛 GitHub Check: Vale style check
[warning] 78-78:
[vale] reported by reviewdog 🐶
[WSO2-IAM.SentenceLength] Try to keep sentences short (< 30 words).
Raw Output:
{"message": "[WSO2-IAM.SentenceLength] Try to keep sentences short (\u003c 30 words).", "location": {"path": "en/identity-server/5.11.0/docs/develop/writing-a-post-authentication-handler.md", "range": {"start": {"line": 78, "column": 4}}}, "severity": "INFO"}
🤖 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/develop/writing-a-post-authentication-handler.md`
at line 78, The long sentence describing required request fields for a
post-authentication handler should be split into two short, clear sentences:
first state that when an external page submits a response to a
post-authentication handler that is already in progress, additional request
fields are required; second list that these fields must be included along with
the input data received from the external page. Update the paragraph around the
current sentence in writing-a-post-authentication-handler.md to use two concise
sentences for clarity and scanning.
|
|
||
| !!! info "Why do these claims need to be edited?" | ||
| These attributes are not supported by Active Directory by default.Therefore if these attributes are ticked as **Supported by Default** in Identity Server, they will be shown in the default user profile and you will recieve an error once you try to update the user profile. | ||
| These attributes are not supported by Active Directory by default.Therefore if these attributes are ticked as **Supported by Default** in Identity Server, they will be shown in the default user profile and you will receive an error once you try to update the user profile. |
Contributor
There was a problem hiding this comment.
Correct spelling fix, but add missing space after period.
The spelling correction from "recieve" to "receive" is correct. However, there's a missing space after the period in "default.Therefore" which should be "default. Therefore".
📝 Proposed fix for spacing issue
- These attributes are not supported by Active Directory by default.Therefore if these attributes are ticked as **Supported by Default** in Identity Server, they will be shown in the default user profile and you will receive an error once you try to update the user profile.
+ These attributes are not supported by Active Directory by default. Therefore if these attributes are ticked as **Supported by Default** in Identity Server, they will be shown in the default user profile and you will receive an error once you try to update the user profile.📝 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
| These attributes are not supported by Active Directory by default.Therefore if these attributes are ticked as **Supported by Default** in Identity Server, they will be shown in the default user profile and you will receive an error once you try to update the user profile. | |
| These attributes are not supported by Active Directory by default. Therefore if these attributes are ticked as **Supported by Default** in Identity Server, they will be shown in the default user profile and you will receive an error once you try to update the user profile. |
🤖 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/guides/login/log-into-office365-using-ws-trust.md`
at line 74, The sentence contains a missing space after the period in the
fragment "default.Therefore" (and already-corrected "recieve" -> "receive");
update the text so the fragment reads "default. Therefore" to fix the spacing in
the document (search for the string "default.Therefore" to locate the
paragraph).
| - **POST** operation: Adds new resources. | ||
| - **PUT** operation: Replaces an existing resource. | ||
| - **PATCH** opearation: Updates attribues of an existing resource. | ||
| - **PATCH** opearation: Updates attributes of an existing resource. |
Contributor
There was a problem hiding this comment.
Correct spelling in PATCH operation description.
The term opearation is misspelled; replace it with operation.
Suggested fix
- - **PATCH** opearation: Updates attributes of an existing resource.
+ - **PATCH** operation: Updates attributes of an existing resource.📝 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
| - **PATCH** opearation: Updates attributes of an existing resource. | |
| - **PATCH** operation: Updates attributes of an existing resource. |
🤖 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/apis/restapis/scim2.yaml` at line 1204, Fix the
typo in the PATCH description in the scim2.yaml by replacing "opearation" with
"operation" in the line that reads "- **PATCH** opearation: Updates attributes
of an existing resource." so the description becomes "- **PATCH** operation:
Updates attributes of an existing resource."; locate and update the PATCH
description string in the SCIM2 API docs (scim2.yaml) accordingly.
| in the <code>IDENTITY_DB</code>. | ||
| In a deployment, both identity and UMA can be configured in a single database while consent data is configured to a seperate | ||
| In a deployment, both identity and UMA can be configured in a single database while consent data is configured to a separate | ||
| database `CONSENT_MGT`</li>. |
Contributor
There was a problem hiding this comment.
Fix HTML formatting and use consistent code tags.
Two minor formatting issues:
- The period should appear before the closing
</li>tag, not after it - For consistency with other database names in the document (lines 43, 53, 72, 84), use
<code>tags instead of backticks
📝 Proposed fix
- database `CONSENT_MGT`</li>.
+ database <code>CONSENT_MGT</code>.</li>🤖 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/deploy/set-up-separate-databases-for-clustering.md`
at line 59, Update the list item that currently contains "database
`CONSENT_MGT`</li>." so the sentence-ending period is placed before the closing
</li> tag and replace the backtick-wrapped CONSENT_MGT with an HTML
<code>CONSENT_MGT</code> tag to match other database name formatting; locate the
list element in the same block that contains the text "database `CONSENT_MGT`"
and apply these two edits together.
|
|
||
| !!! info "Why do these claims need to be edited?" | ||
| These attributes are not supported by Active Directory by default.Therefore if these attributes are ticked as **Supported by Default** in Identity Server, they will be shown in the default user profile and you will recieve an error once you try to update the user profile. | ||
| These attributes are not supported by Active Directory by default.Therefore if these attributes are ticked as **Supported by Default** in Identity Server, they will be shown in the default user profile and you will receive an error once you try to update the user profile. |
Contributor
There was a problem hiding this comment.
Correct spelling fix, but add missing space after period.
The spelling correction from "recieve" to "receive" is correct. However, there's a missing space after the period in "default.Therefore" which should be "default. Therefore".
📝 Proposed fix for spacing issue
- These attributes are not supported by Active Directory by default.Therefore if these attributes are ticked as **Supported by Default** in Identity Server, they will be shown in the default user profile and you will receive an error once you try to update the user profile.
+ These attributes are not supported by Active Directory by default. Therefore if these attributes are ticked as **Supported by Default** in Identity Server, they will be shown in the default user profile and you will receive an error once you try to update the user profile.📝 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
| These attributes are not supported by Active Directory by default.Therefore if these attributes are ticked as **Supported by Default** in Identity Server, they will be shown in the default user profile and you will receive an error once you try to update the user profile. | |
| These attributes are not supported by Active Directory by default. Therefore if these attributes are ticked as **Supported by Default** in Identity Server, they will be shown in the default user profile and you will receive an error once you try to update the user profile. |
🤖 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/guides/login/log-into-office365-using-ws-trust.md`
at line 74, Update the sentence that begins "These attributes are not supported
by Active Directory by default.Therefore..." in the
log-into-office365-using-ws-trust.md document: add a space after the period so
it reads "default. Therefore" and ensure the word "receive" is spelled correctly
(replace any "recieve" occurrences). Save the corrected sentence so it reads:
"These attributes are not supported by Active Directory by default. Therefore,
if these attributes are ticked as **Supported by Default** in Identity Server,
they will be shown in the default user profile and you will receive an error
once you try to update the user profile."
| apiResponse = "Error invoking protected API."; | ||
| // Handle error (unauthorized, forbidden, etc.) | ||
| Console.WriteLine("Error invoking protected API. Recieved an unsuccessful response: " + response.StatusCode); | ||
| Console.WriteLine("Error invoking protected API. received an unsuccessful response: " + response.StatusCode); |
Contributor
There was a problem hiding this comment.
Polish the log message grammar on Line 253.
The typo is fixed, but the sentence still reads awkwardly (... API. received ...). Consider making it a single clear sentence.
Suggested edit
-Console.WriteLine("Error invoking protected API. received an unsuccessful response: " + response.StatusCode);
+Console.WriteLine("Error invoking protected API: received an unsuccessful response: " + response.StatusCode);As per coding guidelines, "Use plain language and short sentences" and "Keep a professional, friendly, neutral tone."
📝 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
| Console.WriteLine("Error invoking protected API. received an unsuccessful response: " + response.StatusCode); | |
| Console.WriteLine("Error invoking protected API: received an unsuccessful response: " + response.StatusCode); |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@en/includes/complete-guides/dotnet/protected-api.md` at line 253, The
Console.WriteLine call that logs the protected API error currently splits the
sentence ("API. received ..."); update the message in the Console.WriteLine that
references response.StatusCode to be a single clear sentence using plain
language (e.g., combine into one sentence like "Error invoking protected API:
received an unsuccessful response (StatusCode: ...)" or similar), ensuring
proper capitalization and including response.StatusCode for context.
ashanthamara
previously approved these changes
Apr 17, 2026
Co-authored-by: Pavindu Lakshan <pavindulakshan@gmail.com>
pavinduLakshan
approved these changes
Apr 17, 2026
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
3 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.
$subject