Document Redis Configuration and Scope/Operation Behavior During API Import

[DakshithaS]

This pull request introduces comprehensive documentation and configuration updates for Redis-backed distributed throttling in the API Gateway, including new configuration examples, catalog entries, and important clarifications for API import behavior. The main changes are grouped below.

Redis Throttling Configuration Documentation and Examples:

• Added detailed documentation for new Redis connection and pool configuration options (connection_timeout, socket_timeout, ssl, and pool_options.max_wait_millis) in the API Gateway rate limiting guide, including warnings about safe production values.
• Added new example TOML files: apim.redis_config.toml for Redis connection settings and apim.redis_config.pool_options.toml for connection pool tuning. [1] [2]

Configuration Catalog Enhancements:

• Updated configs.json to include the new Redis configuration sections with detailed parameter descriptions and linked example files, improving discoverability and usability for users configuring distributed throttling.

API Import Behavior Clarifications:

• Added warnings to the API import and migration documentation clarifying that scopes and operations must be defined in the API definition file (Swagger/OpenAPI), not in api.yaml, or they will be silently dropped during import. [1] [2]

Related Issues

• https://github.com/wso2-enterprise/wso2-apim-internal/issues/16834
• https://github.com/wso2-enterprise/wso2-apim-internal/issues/15837

[coderabbitai]

📝 Walkthrough

Summary

• Documented Redis-backed distributed throttling configuration for API Gateway clusters.
• Added Redis connection, timeout, TLS, and connection-pool settings with production guidance.
• Added Redis configuration examples and updated the configuration catalog.
• Clarified that API scopes and operations must be defined in Swagger/OpenAPI files during import and migration.

Walkthrough

The changes add Redis connection and Jedis pool settings to the API-M configuration catalog and document their use for distributed or hybrid throttling. The documentation covers timeouts, TLS, gateway identity, pool limits, and wait behavior. API import guides now state that scopes and operations must be defined in the API definition file because values placed only in api.yaml are discarded.

Suggested reviewers: chamilaadhi, tharikagithub, dushaniw

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description explains the main changes and related issues but omits most required template sections, including testing, security, release notes, and migration details.	Complete the required template sections and provide applicable details or explicit N/A entries for testing, security, documentation, release notes, and other impacts.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly summarizes both major changes: Redis configuration documentation and API import behavior clarifications.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In
`@en/docs/api-gateway/rate-limiting/configuring-rate-limiting-api-gateway-cluster.md`:
- Around line 158-161: Update the pool_options.max_wait_millis row in the
configuration table to mark the parameter as Optional instead of Mandatory,
retaining the existing default of -1 and the production warning unchanged.

🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: f223c82a-6a07-4b07-a6ba-73a63715567a

📥 Commits

Reviewing files that changed from the base of the PR and between f0394d1 and f0de4d0.

📒 Files selected for processing (7)

• en/docs/api-gateway/rate-limiting/configuring-rate-limiting-api-gateway-cluster.md
• en/docs/apiops/cli/managing-apis-api-products/importing-apis-via-dev-first-approach.md
• en/docs/apiops/cli/managing-apis-api-products/migrating-apis-to-different-environments.md
• en/docs/reference/config-catalog.md
• en/tools/config-catalog-generator/data/apim.redis_config.pool_options.toml
• en/tools/config-catalog-generator/data/apim.redis_config.toml
• en/tools/config-catalog-generator/data/configs.json

[npamudika]

+1 for the APICTL related doc changes