Fix: Document IDP cache configuration for APIM-IS integration [master]

[wso2-engineering-bot]

This PR was automatically generated by Claude AI.

• Issue: Caching configurations #10957
• Type: Suggestions / Documentation
• Summary: Added documentation for IDP cache configuration (idp_cache_by_name) that affects how quickly IDP configuration changes are reflected between APIM and IS carbon portals in integrated deployments. This addresses the 15-minute delay mentioned in the issue and provides reference to WSO2 IS documentation for detailed cache layer information.
• Style Scope Verification: Microsoft Style Guidelines have been applied ONLY to newly added content without modifying existing content style.
• Verification: Documentation builds successfully (pre-existing mkdocs.yml configuration warnings unrelated to this change)

Summary by CodeRabbit

Documentation

• Added Identity Provider cache configuration documentation, including TOML configuration examples, detailed parameter definitions for enable/timeout/capacity, practical guidance for configuring cache behavior, and important notes about configuration update propagation timing in integrated API Manager and Identity Server deployments.

[coderabbitai]

Walkthrough

Added documentation for Identity Provider cache configuration in WSO2 API Manager deployments with shared databases. The new section includes TOML configuration syntax, parameter definitions, and operational timing details for the idp_cache_by_name cache mechanism.

Changes

Cohort / File(s)	Summary
Documentation en/docs/install-and-setup/setup/advance-configurations/configuring-caching.md	Added "Identity provider cache" section describing IDP configuration caching behavior, including TOML configuration example, parameter table (enable, timeout, capacity), and operational notes about cache propagation timing in integrated deployments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 A cache for the identities, fifteen minutes to spare,
WSO2's secrets now documented with care,
Configuration flows smoothly, database lookups despair no more,
Documentation hops forward, enriching the lore! ✨

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description is largely incomplete; it lacks most required sections from the template including Goals, Approach, User stories, Release note, Training, Certification, Marketing, Tests, Security checks, Samples, Migrations, and Test environment details.	Complete the PR description by filling in all applicable sections from the template, particularly Goals, Approach, Release note, Documentation, and Test environment sections relevant to documentation changes.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes the main change: documenting IDP cache configuration for API Manager and Identity Server integration, which directly matches the changeset content.
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
• Commit unit tests in branch fixing-issue-10957-master-1773992707

📝 Coding Plan

• Generate coding plan for human review comments

---

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

[coderabbitai]

🧹 Nitpick comments (1)

en/docs/install-and-setup/setup/advance-configurations/configuring-caching.md (1)

72-100: Good addition; consider linking this section from the APIM-IS integration setup page.

This new section is valuable, but users following the Resident Key Manager integration flow may miss it. Add a short “see also” link from en/docs/install-and-setup/setup/distributed-deployment/configuring-wso2-identity-server-as-a-key-manager.md to improve discoverability.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In
`@en/docs/install-and-setup/setup/advance-configurations/configuring-caching.md`
around lines 72 - 100, Add a "See also" link in the Resident Key Manager
integration doc
en/docs/install-and-setup/setup/distributed-deployment/configuring-wso2-identity-server-as-a-key-manager.md
that points to the new "Identity provider cache" section in
en/docs/install-and-setup/setup/advance-configurations/configuring-caching.md
(use the section title "Identity provider cache" as the anchor text). Place the
link near the top or in the related configuration/notes area so readers of the
APIM-IS integration flow will discover the idp_cache_by_name guidance; ensure
the link text is concise (e.g., "See Identity provider cache in Advanced
Configurations") and uses the same relative path/anchor format used by other
internal doc cross-references.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In
`@en/docs/install-and-setup/setup/advance-configurations/configuring-caching.md`:
- Around line 72-100: Add a "See also" link in the Resident Key Manager
integration doc
en/docs/install-and-setup/setup/distributed-deployment/configuring-wso2-identity-server-as-a-key-manager.md
that points to the new "Identity provider cache" section in
en/docs/install-and-setup/setup/advance-configurations/configuring-caching.md
(use the section title "Identity provider cache" as the anchor text). Place the
link near the top or in the related configuration/notes area so readers of the
APIM-IS integration flow will discover the idp_cache_by_name guidance; ensure
the link text is concise (e.g., "See Identity provider cache in Advanced
Configurations") and uses the same relative path/anchor format used by other
internal doc cross-references.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 959feb0b-7655-44ed-999f-18699601bdbc

📥 Commits

Reviewing files that changed from the base of the PR and between 05b1d74 and 92576c3.

📒 Files selected for processing (1)

• en/docs/install-and-setup/setup/advance-configurations/configuring-caching.md