[7.1][7.2] Add Custom Header Filter documentation to supported versions#5821
[7.1][7.2] Add Custom Header Filter documentation to supported versions#5821HasiniSama merged 1 commit intowso2:masterfrom
Conversation
WalkthroughThis change introduces a new custom header filter documentation feature across multiple product versions. A shared documentation template is created in the includes directory, then integrated into Asgardeo and Identity Server documentation (versions 6.1.0, 7.1.0, 7.2.0, and next) via version-specific wrapper files with template variables. Navigation entries are added to corresponding MkDocs configuration files. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Poem
🚥 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}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Fix all issues with AI agents
In @en/identity-server/6.1.0/docs/deploy/custom-header-filter.md:
- Around line 36-44: The curl example contains hardcoded Base64 basic auth
header ("Authorization: Basic YWRtaW46YWRtaW4="); replace this with a
placeholder token header such as "Authorization: Bearer {bearer_token}" and
update the surrounding text to instruct users how to obtain a token (e.g.,
OAuth2 token endpoint or CLI login) instead of embedding credentials; ensure the
example uses the placeholder consistently and remove any real credentials from
the request sample.
- Around line 81-84: Update the curl example to use the template variable and
Bearer token placeholder used elsewhere: replace the path segment
"{root_organization_name}" with the template variable "{{ root_organization_path
}}" and change the Authorization header from the hardcoded Basic credential to a
Bearer placeholder "Authorization: Bearer <access_token>" so the example aligns
with en/includes/deploy/configure/custom-header-filter.md.
- Around line 53-56: Fix the typo in the curl URL (change "hhttps://" to
"https://") and replace hardcoded values with template placeholders: use {{
host_name }} instead of localhost and {{ root_organization_path }} or {{
root_organization_name }} instead of the literal path, and remove the Base64
"Authorization: Basic YWRtaW46YWRtaW4=" header—use a placeholder like
"Authorization: Bearer {bearer_token}" so callers supply their own token; update
the affected curl invocation accordingly (the line starting with curl -k -X POST
and the Authorization header).
In @en/includes/deploy/configure/custom-header-filter.md:
- Around line 1-101: The 6.1.0 documentation copy contains hardcoded Basic auth,
a URL typo, and structural divergence from the template; remove the hardcoded
"Authorization: Basic YWRtaW46YWRtaW4=" entries and replace them with the
{bearer_token} placeholder used elsewhere (search for the "Authorization:"
header lines), fix the "hhttps://" typo to "https://" (search for the malformed
URL string), and restore the missing conditional sections ("Prerequisites" and
"Enable custom header filter") or convert the file to use the same template
inclusion/variable substitution approach as 7.1.0+ (use placeholders like {{
host_name }} and {{ root_organization_path }} and the product_name conditionals)
to ensure consistency and remove any inline credentials from the doc.
🧹 Nitpick comments (1)
en/asgardeo/docs/references/custom-header-filter.md (1)
1-3: Template wrapper looks correct; double-checkroot_organization_pathvalueThe structure (setting
host_name,root_organization_path, then including the shared snippet) matches other templated reference docs and cleanly reuses common content.One thing to verify: if the included file constructs URLs as
https://{{ host_name }}/{{ root_organization_path }}/..., you may wantroot_organization_pathto match the usual Asgardeo API pattern (e.g., including/t/before{root_organization_name}if that’s how other API docs are written) so the examples resolve to the correct base path.
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (11)
en/asgardeo/docs/references/custom-header-filter.mden/asgardeo/mkdocs.ymlen/identity-server/6.1.0/docs/deploy/custom-header-filter.mden/identity-server/6.1.0/mkdocs.ymlen/identity-server/7.1.0/docs/deploy/configure/custom-header-filter.mden/identity-server/7.1.0/mkdocs.ymlen/identity-server/7.2.0/docs/deploy/configure/custom-header-filter.mden/identity-server/7.2.0/mkdocs.ymlen/identity-server/next/docs/deploy/configure/custom-header-filter.mden/identity-server/next/mkdocs.ymlen/includes/deploy/configure/custom-header-filter.md
🧰 Additional context used
🪛 Gitleaks (8.30.0)
en/identity-server/6.1.0/docs/deploy/custom-header-filter.md
[high] 36-39: Discovered a potential authorization token provided in a curl command header, which could compromise the curl accessed resource.
(curl-auth-header)
[high] 53-56: Discovered a potential authorization token provided in a curl command header, which could compromise the curl accessed resource.
(curl-auth-header)
[high] 81-84: Discovered a potential authorization token provided in a curl command header, which could compromise the curl accessed resource.
(curl-auth-header)
🪛 LanguageTool
en/identity-server/6.1.0/docs/deploy/custom-header-filter.md
[style] ~67-~67: Using many exclamation marks might seem excessive (in this case: 9 exclamation marks for a text that’s 1736 characters long)
Context: ...c '''self'''" } ] }' ``` !!! note Replace console with the web...
(EN_EXCESSIVE_EXCLAMATION)
en/includes/deploy/configure/custom-header-filter.md
[style] ~79-~79: Using many exclamation marks might seem excessive (in this case: 9 exclamation marks for a text that’s 1917 characters long)
Context: ...c '''self'''" } ] }' ``` !!! note Replace console with the web...
(EN_EXCESSIVE_EXCLAMATION)
🔇 Additional comments (5)
en/asgardeo/mkdocs.yml (1)
737-737: Nav entry for Custom Header Filter is consistent and correctly placedLabel and path (
references/custom-header-filter.md) align with the new doc and existing references (e.g., CORS, templates). No issues from a navigation/config perspective.en/identity-server/7.2.0/mkdocs.yml (1)
905-905: Custom Header Filter added correctly under Setup → ConfigureThe new entry (
deploy/configure/custom-header-filter.md) is named and positioned consistently with nearby deployment configuration topics (CORS, clock tolerance). Looks good.en/identity-server/7.1.0/mkdocs.yml (1)
846-846: Consistent Setup → Configure entry for Custom Header FilterThe new item (
deploy/configure/custom-header-filter.md) is placed and named consistently with 7.2.0 and neighboring config topics (CORS, clock tolerance, cookie banner). Navigation wiring looks correct.en/identity-server/next/mkdocs.yml (1)
906-906: LGTM - Navigation entry is correctly structured.The navigation entry for "Custom Header Filter" is appropriately placed under the "Configure" section and uses the correct path
deploy/configure/custom-header-filter.md, which matches the actual file location for this version.Note: This differs from version 6.1.0, which places it under "Email Notifications" and uses a different path (
deploy/custom-header-filter.md). The placement here is more semantically appropriate.en/identity-server/6.1.0/mkdocs.yml (1)
421-421: The original review identifies two issues that are both factually incorrect:
Path is correct: The file exists at
en/identity-server/6.1.0/docs/deploy/custom-header-filter.md, which matches the mkdocs.yml entrydeploy/custom-header-filter.md. There is no file at the alternative pathdeploy/configure/custom-header-filter.md.Navigation placement is correct: "Custom Header Filter" is not placed under the "Email Notifications" section. It is a peer entry at the Configure section level, positioned alongside CORS, reCAPTCHA, and other configuration options—exactly where it should be.
Likely an incorrect or invalid review comment.
HasiniSama
force-pushed
the
custom-header
branch
from
dd54af2 to
6ac576c
Compare
HasiniSama
changed the title
|
The vale lint issues are for variables...not for grammar improvements. |
2 participants
Purpose
$subject
Don't merge until:
Issues:
7.1.0
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.