Fix: Add missing documentation for IS 7.0.0, 7.1.0, and 7.2.0 (Product IS issue #26299) #5779
Conversation
…t-is#26299) This PR adds two documentation sections that were present in IS 6.1.0 but missing in IS 7.0.0, 7.1.0, and 7.2.0: 1. Advanced OpenID Connect Configurations - Comprehensive guide for advanced OAuth/OIDC settings 2. Customize Authentication Error Messages - Instructions for customizing authentication error handling Changes: - Added oauth-app-config-advanced.md to guides/authentication/oidc/ for all three versions - Added customize-authentication-error-messages.md to references/extend/authentication/ for all three versions - Updated mkdocs.yml navigation for all three versions to include the new documentation 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
|
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. |
WalkthroughDocumentation additions across Identity Server versions 7.0.0, 7.1.0, and 7.2.0 introducing guides for advanced OpenID Connect configurations and authentication error message customization, accompanied by corresponding mkdocs.yml navigation updates. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✨ 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}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
en/identity-server/7.2.0/docs/references/extend/authentication/customize-authentication-error-messages.md (1)
30-30: Fix grammar: Hyphenate "above-mentioned" in compound adjective.Line 30 uses "above mentioned" where "above-mentioned" is grammatically correct when preceding a noun.
-If the `showAuthFailureReason` property is enabled, the user will be redirected to the `retry.do` page with the above mentioned query parameters during the authentication flow. +If the `showAuthFailureReason` property is enabled, the user will be redirected to the `retry.do` page with the above-mentioned query parameters during the authentication flow.en/identity-server/7.1.0/docs/references/extend/authentication/customize-authentication-error-messages.md (1)
30-30: Fix grammar: Hyphenate "above-mentioned" in compound adjective.Line 30 uses "above mentioned" where "above-mentioned" is grammatically correct when preceding a noun. This same issue appears in the 7.0.0 version as well.
-If the `showAuthFailureReason` property is enabled, the user will be redirected to the `retry.do` page with the above mentioned query parameters during the authentication flow. +If the `showAuthFailureReason` property is enabled, the user will be redirected to the `retry.do` page with the above-mentioned query parameters during the authentication flow.en/identity-server/7.0.0/docs/guides/authentication/oidc/oauth-app-config-advanced.md (1)
72-73: Minor style: Consider rewording to avoid repeated word at sentence start.Lines 72–73 have stylistic repetition starting with "PKCE":
- Bullet point: "- PKCE Mandatory: Select this..."
- Next sentence: "PKCE is a recommended security measure..."
Rewording slightly improves readability:
- **PKCE Mandatory**: Select this if you are using the <strong>Code</strong> grant type. PKCE is a recommended security measure used to mitigate a code interception attack. !!! info - See [Mitigating Authorization Code Interception Attacks]({{base_path}}/deploy/mitigate-attacks/mitigate-authorization-code-interception-attacks/) for more information. + See [Mitigating Authorization Code Interception Attacks]({{base_path}}/deploy/mitigate-attacks/mitigate-authorization-code-interception-attacks/) for more information on this recommended practice.Alternatively, restructure to:
- **PKCE Mandatory**: A recommended security measure to mitigate code interception attacks. Select this if you are using the <strong>Code</strong> grant type. See [Mitigating Authorization Code Interception Attacks]({{base_path}}/deploy/mitigate-attacks/mitigate-authorization-code-interception-attacks/) for more information.en/identity-server/7.0.0/docs/references/extend/authentication/customize-authentication-error-messages.md (1)
30-30: Fix grammar: Hyphenate "above-mentioned" in compound adjective.Line 30 uses "above mentioned" where "above-mentioned" is grammatically correct when preceding a noun.
-If the `showAuthFailureReason` property is enabled, the user will be redirected to the `retry.do` page with the above mentioned query parameters during the authentication flow. +If the `showAuthFailureReason` property is enabled, the user will be redirected to the `retry.do` page with the above-mentioned query parameters during the authentication flow.en/identity-server/7.2.0/docs/guides/authentication/oidc/oauth-app-config-advanced.md (1)
72-73: Minor style: Consider rewording to avoid repeated word at sentence start.Lines 72–73 have stylistic repetition starting with "PKCE". Rewording slightly improves readability:
- **PKCE Mandatory**: Select this if you are using the <strong>Code</strong> grant type. PKCE is a recommended security measure used to mitigate a code interception attack. !!! info - See [Mitigating Authorization Code Interception Attacks]({{base_path}}/deploy/mitigate-attacks/mitigate-authorization-code-interception-attacks/) for more information. + See [Mitigating Authorization Code Interception Attacks]({{base_path}}/deploy/mitigate-attacks/mitigate-authorization-code-interception-attacks/) for more information on this recommended practice.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
en/identity-server/7.0.0/docs/guides/authentication/oidc/oauth-app-config-advanced.md(1 hunks)en/identity-server/7.0.0/docs/references/extend/authentication/customize-authentication-error-messages.md(1 hunks)en/identity-server/7.0.0/mkdocs.yml(2 hunks)en/identity-server/7.1.0/docs/guides/authentication/oidc/oauth-app-config-advanced.md(1 hunks)en/identity-server/7.1.0/docs/references/extend/authentication/customize-authentication-error-messages.md(1 hunks)en/identity-server/7.1.0/mkdocs.yml(2 hunks)en/identity-server/7.2.0/docs/guides/authentication/oidc/oauth-app-config-advanced.md(1 hunks)en/identity-server/7.2.0/docs/references/extend/authentication/customize-authentication-error-messages.md(1 hunks)en/identity-server/7.2.0/mkdocs.yml(2 hunks)
🧰 Additional context used
🪛 LanguageTool
en/identity-server/7.2.0/docs/guides/authentication/oidc/oauth-app-config-advanced.md
[style] ~72-~72: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...g the Code grant type. PKCE is a recommended security measure used ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
en/identity-server/7.0.0/docs/guides/authentication/oidc/oauth-app-config-advanced.md
[style] ~72-~72: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...g the Code grant type. PKCE is a recommended security measure used ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
en/identity-server/7.1.0/docs/guides/authentication/oidc/oauth-app-config-advanced.md
[style] ~72-~72: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...g the Code grant type. PKCE is a recommended security measure used ...
(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
en/identity-server/7.1.0/docs/references/extend/authentication/customize-authentication-error-messages.md
[style] ~10-~10: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1499 characters long)
Context: ...ials - Invalid user - Account lock !!! note Account lock errors are return...
(EN_EXCESSIVE_EXCLAMATION)
[grammar] ~30-~30: Use a hyphen to join words.
Context: ...ed to the retry.do page with the above mentioned query parameters during the au...
(QB_NEW_EN_HYPHEN)
en/identity-server/7.0.0/docs/references/extend/authentication/customize-authentication-error-messages.md
[style] ~10-~10: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1499 characters long)
Context: ...ials - Invalid user - Account lock !!! note Account lock errors are return...
(EN_EXCESSIVE_EXCLAMATION)
[grammar] ~30-~30: Use a hyphen to join words.
Context: ...ed to the retry.do page with the above mentioned query parameters during the au...
(QB_NEW_EN_HYPHEN)
en/identity-server/7.2.0/docs/references/extend/authentication/customize-authentication-error-messages.md
[style] ~10-~10: Using many exclamation marks might seem excessive (in this case: 3 exclamation marks for a text that’s 1499 characters long)
Context: ...ials - Invalid user - Account lock !!! note Account lock errors are return...
(EN_EXCESSIVE_EXCLAMATION)
[grammar] ~30-~30: Use a hyphen to join words.
Context: ...ed to the retry.do page with the above mentioned query parameters during the au...
(QB_NEW_EN_HYPHEN)
🔇 Additional comments (7)
en/identity-server/7.2.0/mkdocs.yml (2)
634-634: Navigation entry correctly placed and formatted.The addition of the Advanced OpenID Connect Configurations guide is properly located within the OIDC flows section of the navigation tree.
1248-1248: Navigation entry correctly placed and formatted.The addition of the authentication error message customization reference is properly positioned within the Authentication extensions section.
en/identity-server/7.0.0/mkdocs.yml (2)
592-592: Navigation entry correctly placed and formatted.The addition of the Advanced OpenID Connect Configurations guide is properly integrated into the OIDC flows section of the navigation hierarchy, maintaining consistency across versions.
1063-1063: Navigation entry correctly placed and formatted.The authentication error message customization reference is correctly positioned within the Authentication extensions documentation, aligning with the information architecture.
en/identity-server/7.1.0/mkdocs.yml (2)
622-622: Navigation entry placement is correct.The "Advanced OpenID Connect Configurations" entry is properly positioned as a sibling configuration option under "Configure OIDC flows," at the same indentation level as the "Logout" subsection. The file reference is accurate.
1166-1166: Navigation entry placement is correct.The "Customize authentication error messages" entry is properly positioned under "Authentication" extensions, at the appropriate indentation level alongside other authentication-related extensions. The file reference is accurate.
en/identity-server/7.1.0/docs/guides/authentication/oidc/oauth-app-config-advanced.md (1)
1-151: Comprehensive documentation with accurate content and proper structure.The file is well-organized, clearly written, and covers all essential advanced OIDC configuration options. Use of MkDocs syntax (collapsible sections, admonitions, code blocks) is appropriate and follows best practices. Internal links correctly use the
{{base_path}}template variable, and external RFC references are properly formatted with target="_blank" directives.The TOML configuration example at lines 150–151 is valid and provides practical guidance. Content accuracy is solid across all 13 sections.
This PR was automatically generated by Claude AI.
Issue
Changes
This PR addresses the missing documentation identified in the product-is issue by adding two critical documentation pages to all affected versions:
Advanced OpenID Connect Configurations (
oauth-app-config-advanced.md)guides/authentication/oidc/Customize Authentication Error Messages (
customize-authentication-error-messages.md)references/extend/authentication/Affected Versions
All three versions now include both documentation pages with appropriate navigation entries in their respective
mkdocs.ymlfiles.Files Changed
en/identity-server/7.0.0/docs/guides/authentication/oidc/oauth-app-config-advanced.mden/identity-server/7.0.0/docs/references/extend/authentication/customize-authentication-error-messages.mden/identity-server/7.0.0/mkdocs.ymlen/identity-server/7.1.0/docs/guides/authentication/oidc/oauth-app-config-advanced.mden/identity-server/7.1.0/docs/references/extend/authentication/customize-authentication-error-messages.mden/identity-server/7.1.0/mkdocs.ymlen/identity-server/7.2.0/docs/guides/authentication/oidc/oauth-app-config-advanced.mden/identity-server/7.2.0/docs/references/extend/authentication/customize-authentication-error-messages.mden/identity-server/7.2.0/mkdocs.ymlNotes
🤖 Generated with Claude Code
Summary by CodeRabbit
Documentation
✏️ Tip: You can customize this high-level summary in your review settings.