Skip to content

Update timeout docs with the new configs#2324

Open
O-sura wants to merge 1 commit into
wso2:mainfrom
O-sura:apip-resiliency-docs
Open

Update timeout docs with the new configs#2324
O-sura wants to merge 1 commit into
wso2:mainfrom
O-sura:apip-resiliency-docs

Conversation

@O-sura

@O-sura O-sura commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Purpose

This PR adds the latest updated documentation for configuring timeouts in WSO2 API Platform gateway

@coderabbitai

coderabbitai Bot commented Jun 30, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

Warning

Review limit reached

@O-sura, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 15 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: ec88e36b-0e40-419c-ab97-6868526b6a2c

📥 Commits

Reviewing files that changed from the base of the PR and between ef1350d and ec3dba6.

📒 Files selected for processing (1)
  • docs/gateway/resiliency/upstream-timeouts.md
📝 Walkthrough

Walkthrough

The file docs/gateway/resiliency/upstream-timeouts.md is rewritten from a narrow upstream connect timeout guide into a comprehensive "Gateway Timeouts" reference. It introduces a two-layer timeout model: router-level defaults (upstream and downstream/HCM fields in config.toml) and API-level overrides (per-upstream connect timeout and resilience route/idle timeouts). Precedence rules for RestApi (API vs operation level) and LlmProvider/LlmProxy are documented. Practical guidance and example scenarios are expanded to cover connect, route, idle, and HCM timeouts.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description only covers Purpose and a related issue, but omits most required template sections. Add the missing template sections: Goals, Approach, User stories, Documentation, Automation tests, Security checks, Samples, Related PRs, and Test environment.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise and accurately summarizes the timeout documentation update.
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

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

@O-sura O-sura force-pushed the apip-resiliency-docs branch from ef1350d to ec3dba6 Compare June 30, 2026 08:25
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.

1 participant