Add disable_double_encoding config info #5832
Conversation
NutharaNR
changed the title
WalkthroughDocumentation update adding conditional informational blocks to SAML artifact binding guide that explain disabling double encoding in deployment.toml for product versions 7.1.0 and 7.2.0, with accompanying configuration examples. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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: 1
🤖 Fix all issues with AI agents
In `@en/includes/guides/authentication/saml/saml-artifact-binding.md`:
- Line 213: The MkDocs admonition type in the documentation uses an uppercase
identifier; change the admonition heading `Info` to lowercase `info` (i.e.,
replace `!!! Info` with `!!! info`) so MkDocs Material will recognize and render
the admonition correctly in saml-artifact-binding.md.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
en/includes/guides/authentication/saml/saml-artifact-binding.md
🔇 Additional comments (2)
en/includes/guides/authentication/saml/saml-artifact-binding.md (2)
212-221: Documentation accurately reflects the version-specific behavior.The conditional block correctly targets versions 7.1.0 and 7.2.0 where double encoding is the default behavior, and provides clear guidance on how to disable it with the appropriate configuration. The TOML snippet is properly formatted.
212-221: AI summary incorrectly claimed two locations; only one instance exists.The search confirms only a single instance of the
disable_double_encodingconfiguration block exists in the document (line 219). The AI-generated summary stating two locations was inaccurate. The current code placement is correct and complete.
✏️ Tip: You can disable this entire section by setting review_details to false in your review settings.
| If your are using a different URL, add that as an allowed origin. | ||
| {% if is_version == "7.1.0" or is_version == "7.2.0" %} | ||
| !!! Info |
There was a problem hiding this comment.
Use lowercase for MkDocs admonition type.
MkDocs Material requires lowercase admonition identifiers. Change Info to info for proper rendering.
📝 Proposed fix
- !!! Info
+ !!! info📝 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.
| !!! Info | |
| !!! info |
🤖 Prompt for AI Agents
In `@en/includes/guides/authentication/saml/saml-artifact-binding.md` at line 213,
The MkDocs admonition type in the documentation uses an uppercase identifier;
change the admonition heading `Info` to lowercase `info` (i.e., replace `!!!
Info` with `!!! info`) so MkDocs Material will recognize and render the
admonition correctly in saml-artifact-binding.md.
1 participant
Purpose
SAML artifact is being double–URL encoded, even though the SAML specification requires only a single URL encoding[1]. To address this, a new configuration option,
saml.artifact.disable_double_encoding, has been introduced. Its default value in older versions(7.1.0 & 7.2.0) isfalseand in master the value istrue, which enforces the correct (single-encoding) behavior.Related PRs
Related Issues
Test environment
Security checks
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.