Skip to content

Update the refresh token configurations.#5960

Open
Malith-19 wants to merge 2 commits intowso2:masterfrom
Malith-19:update-the-refresh-token-configuration-docs
Open

Update the refresh token configurations.#5960
Malith-19 wants to merge 2 commits intowso2:masterfrom
Malith-19:update-the-refresh-token-configuration-docs

Conversation

@Malith-19
Copy link
Contributor

@Malith-19 Malith-19 commented Mar 12, 2026

Purpose

  • Improve the docs to include only in the Saas and the new identity server version for the extend expiry setting for the refresh token.
  • Add a note for the extend configuration that it only valid if renew refresh token config is already enabled.

Related PRs

Test environment

Security checks

Summary by CodeRabbit

  • Documentation
    • Updated refresh token guidance to be product/version-specific: the "Extend expiry time of renewed refresh token" section is now conditionally displayed only for compatible releases.
    • Moved the explanation about remaining-token validity into the gated section.
    • Added a clarifying note about applicability when renew-refresh-token is enabled.

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 12, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 918a2268-a6bf-47a7-9242-d5ef9629f33e

📥 Commits

Reviewing files that changed from the base of the PR and between 01c9f79 and 1d6966e.

📒 Files selected for processing (1)
  • en/includes/guides/fragments/manage-app/oidc-settings/refresh-token.md

Walkthrough

The "Extend expiry time of renewed refresh token" subsection was wrapped in a conditional so it is shown only for Asgardeo or WSO2 Identity Server versions > 7.2.0; the heading, a note, and the explanatory sentence about remaining-token validity were moved inside that conditional.

Changes

Cohort / File(s) Summary
Version-gated documentation
en/includes/guides/fragments/manage-app/oidc-settings/refresh-token.md
Wrapped the "Extend expiry time of renewed refresh token" subsection in a conditional for Asgardeo or WSO2 IS > 7.2.0; added a gated note about applicability when "Renew refresh token" is enabled; moved explanatory sentence inside the conditional and removed unconditional rendering.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 A rabbit hops through docs so fine,
Gates set by version, neat in line,
Tokens refreshed with cautious cheer,
Shown where versions match the tier,
Hooray for tidy docs — and a carrot near! 🥕

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Title check ❓ Inconclusive The title 'Update the refresh token configurations' is generic and vague, describing what is updated but not the specific change or why. Consider a more specific title like 'Gate refresh token extend expiry setting to SaaS and IS 7.2.0+' to clearly communicate the main change.
✅ Passed checks (2 passed)
Check name Status Explanation
Description check ✅ Passed The description includes purpose and related PRs with good detail, but security checks are not completed and test environment section is empty.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Nitpick comments (1)
en/includes/guides/fragments/manage-app/oidc-settings/refresh-token.md (1)

16-16: Consider clarifying the configuration reference.

The phrase "this configuration" assumes context from surrounding UI or documentation. For improved standalone clarity, consider explicitly naming the configuration setting (e.g., "When you disable the Extend expiry time option..." or similar, depending on the actual UI label).

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@en/includes/guides/fragments/manage-app/oidc-settings/refresh-token.md` at
line 16, Replace the ambiguous phrase "When you set this configuration to
`false`" with an explicit reference to the configuration option by name (for
example, "When you disable the Extend expiry time option" or the actual UI
label), so the sentence reads clearly on its own; update the sentence in
refresh-token.md to mention the specific setting name (e.g., "Extend expiry
time") instead of "this configuration" and keep the rest of the sentence
("renewed refresh tokens carry the remaining validity period of the original
refresh token") unchanged.
🤖 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/includes/guides/fragments/manage-app/oidc-settings/refresh-token.md`:
- Around line 10-11: The heading "Extend expiry time of renewed refresh token"
is using level 3 (###) while surrounding configuration headings use level 4;
change that heading to level 4 (####) inside the same conditional block (the
line with {% if product_name == "Asgardeo" or (product_name == "WSO2 Identity
Server" and is_version > "7.2.0" ) %}) so it matches the other configuration
section headings and preserves the correct hierarchy.

---

Nitpick comments:
In `@en/includes/guides/fragments/manage-app/oidc-settings/refresh-token.md`:
- Line 16: Replace the ambiguous phrase "When you set this configuration to
`false`" with an explicit reference to the configuration option by name (for
example, "When you disable the Extend expiry time option" or the actual UI
label), so the sentence reads clearly on its own; update the sentence in
refresh-token.md to mention the specific setting name (e.g., "Extend expiry
time") instead of "this configuration" and keep the rest of the sentence
("renewed refresh tokens carry the remaining validity period of the original
refresh token") unchanged.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3c362c08-e6c8-43f4-bb5b-4f5327117be1

📥 Commits

Reviewing files that changed from the base of the PR and between 9d0d348 and 01c9f79.

📒 Files selected for processing (1)
  • en/includes/guides/fragments/manage-app/oidc-settings/refresh-token.md

…token.md

Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants