Fix: Update OAuth2/OpenID Connect additional query parameters documentation for versions 5.10.0 and 5.11.0 (Product IS issue #23634)

[wso2-engineering-bot]

This PR was automatically generated by Claude AI.

Issue

• Source Issue: Need to update Oauth2/OpenID connect configurations with additional query params. product-is#23634
• Type: Documentation / Suggestions
• Summary: Update OAuth2/OpenID Connect configuration documentation to include detailed information about additional query parameters feature introduced in 5.10.0 WUM pack

Changes Made

Enhanced the "Additional Query Parameters" section in the OAuth2/OpenID Connect configuration documentation with:

1. Clear categorization of three types of query parameters:

   • Fixed query parameters
   • Dynamic query parameters from the initial request
   • Dynamic query parameters from adaptive authentication scripts

2. Concrete examples including:

   • Fixed parameter: [email protected]
   • Dynamic from request: login_hint=${paramName} or domain=${fidp}
   • Dynamic from adaptive script: login_hint=$authparam{userIdentifier}

3. Sample adaptive authentication script demonstrating the authenticatorParams usage mentioned in the original issue

4. Sample OIDC request showing how parameters are passed in the request URL

5. Proper HTML entity escaping for dollar signs to prevent math rendering issues with the arithmatex extension

Affected Versions

• 5.10.0 ✓
• 5.11.0 ✓

Note: Versions 7.0.0, 7.1.0, 7.2.0, and next already have comprehensive documentation for this feature via shared includes and do not require updates.

Style Scope Verification

Microsoft Style Guidelines have been applied ONLY to newly added content without modifying existing content style unless specifically requested.

Verification

• ✓ mkdocs build passed successfully for version 5.11.0
• ✓ HTML rendering verified - dollar signs display correctly as $ in the output
• ✓ All examples are clear and properly formatted
• ✓ Documentation aligns with the feature capabilities described in the original issue

🤖 Generated with Claude Code

Co-Authored-By: Claude [email protected]

Summary by CodeRabbit

• Documentation
  • Restructured OAuth2/OpenID Connect query parameter documentation with improved organization
  • Added comprehensive examples demonstrating fixed and dynamic parameter configuration
  • Included detailed guidance on referencing parameters from initial requests and adaptive authentication scripts
  • Enhanced formatting and clarifications throughout for improved clarity and usability

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.

---

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.}

[coderabbitai]

Walkthrough

The PR restructures documentation for OAuth2/OpenID Connect "Additional Query Parameters" across two version branches, converting inline parameterized explanations into structured three-part guides with explicit examples and adaptive authentication script samples.

Changes

Cohort / File(s)

Summary

OAuth2/OpenID Connect Documentation Restructuring en/identity-server/5.10.0/docs/learn/configuring-oauth2-openid-connect.md en/identity-server/5.11.0/docs/learn/configuring-oauth2-openid-connect.md

Reorganized "Additional Query Parameters" sections from inline parameterized format to structured three-part guides: (1) Fixed query parameters with examples, (2) Dynamic query parameters from initial requests using syntax like ${paramName}, (3) Dynamic query parameters from adaptive authentication scripts using ${authparam{...}}; added explicit sample requests, clarifications on parameter transmission, adaptive authentication script examples, and improved HTML structure and wording

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verify all code examples and syntax are technically correct (especially ${paramName} and ${authparam{...}} placeholders)
• Confirm consistency in documentation structure and formatting between both version branches
• Check that sample adaptive authentication scripts are valid and functional
• Ensure ampersand-delimited parameter formats are accurately documented

Poem

🐰 Our query parameters were tangled and long,
Now structured in three parts, so clear and so strong,
With samples and scripts that dance in the code,
Documentation now glows on the information road! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description covers the purpose and related issue, but lacks required sections: no test environment details, no security checks section with checkboxes, and no related PRs section are documented.	Add the missing template sections: test environment (JDK, OS, browsers tested), security checks with checkboxes, and related PRs if applicable.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change: updating OAuth2/OpenID Connect documentation for query parameters across two versions, with reference to the source issue.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fixing-product-is-issue-23634-1762499494

---

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between d763c09 and 862b9ac.

📒 Files selected for processing (2)

• en/identity-server/5.10.0/docs/learn/configuring-oauth2-openid-connect.md (1 hunks)
• en/identity-server/5.11.0/docs/learn/configuring-oauth2-openid-connect.md (1 hunks)

🧰 Additional context used

🪛 GitHub Actions: Markdown Lint

en/identity-server/5.10.0/docs/learn/configuring-oauth2-openid-connect.md

[error] 18-18: markdownlint: MD030/list-marker-space Spaces after list markers. markdownlint-cli2-action@v20 failed on this file.

🪛 LanguageTool

en/identity-server/5.10.0/docs/learn/configuring-oauth2-openid-connect.md

[uncategorized] ~155-~155: Loose punctuation mark.
Context: ...C' }] }, {}); } });

Multiple para...

(UNLIKELY_OPENING_PUNCTUATION)

en/identity-server/5.11.0/docs/learn/configuring-oauth2-openid-connect.md

[uncategorized] ~150-~150: Loose punctuation mark.
Context: ...C' }] }, {}); } });

Multiple para...

(UNLIKELY_OPENING_PUNCTUATION)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: Vale style check

🔇 Additional comments (4)

en/identity-server/5.11.0/docs/learn/configuring-oauth2-openid-connect.md (2)

119-157: Excellent restructuring of the Additional Query Parameters documentation.

The three-part categorization (fixed, dynamic from request, dynamic from adaptive script) significantly improves clarity. The concrete examples, sample OIDC request, and inline adaptive authentication script provide practical guidance for users implementing this feature. HTML escaping of dollar signs prevents rendering issues with the arithmatex extension. Overall, the documentation restructuring well addresses the feature's complexity and usage patterns.

---

136-151: Sample adaptive authentication script is clear and instructive.

The script effectively demonstrates how authenticatorParams are used to pass dynamic values to the external IdP, with a realistic example using context.steps[1].subject.username. This concrete sample reduces implementation friction for users.

en/identity-server/5.10.0/docs/learn/configuring-oauth2-openid-connect.md (2)

124-158: Consistent and well-structured documentation across both version branches.

The 5.10.0 version mirrors the improved three-part categorization and examples from 5.11.0, ensuring consistency in the feature documentation across these versions. The content quality, examples, and adaptive authentication script sample are equivalent to the 5.11.0 version.

---

1-20: Pre-existing Markdownlint MD030 error noted for awareness.

The GitHub Actions pipeline reports an MD030 error (list marker spacing) on line 18, which appears unrelated to the current documentation changes. This error likely pre-exists in the file. You may want to address it in a separate pass if it's a known issue, but it doesn't impact the quality of the current PR changes.

---

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

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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