Add Documentation for WebSocket Proxy Profiles

[hisanhunais]

Purpose

Adds a new documentation page for the WebSocket Proxy Profiles feature introduced in WSO2 API Manager 4.7.0.

The WebSocket proxy profile feature allows the Classic Gateway to route outbound WebSocket connections (gateway → backend) through one or more HTTP CONNECT proxies. This is useful in network environments where backend WebSocket services are not directly reachable from the gateway and must be accessed through a corporate or department-level proxy.

The page covers:

• Overview — what proxy profiles are and when to use them
• How It Works — the profile matching logic: specific profiles evaluated first, catch-all as fallback, bypass_hosts precedence
• Configuration — [[transport.ws.proxy_profile]] and [[transport.wss.proxy_profile]] parameters with a full reference table
• Scenarios — step-by-step examples for:
  • Anonymous proxy
  • Authenticated proxy (Basic auth)
  • Bypassing the proxy for selected hosts
  • Catch-all profile with exclusions
  • Connecting to a wss:// backend through a proxy (including truststore setup)
• Limitations — restart requirement, regex matching behavior, ordering rules, Basic auth only, ws/wss independence

[coderabbitai]

Warning

Review limit reached

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

Next review available in: 38 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: 13c9ea38-5322-4a02-913b-188d4865f326

📥 Commits

Reviewing files that changed from the base of the PR and between b789663 and f326d06.

📒 Files selected for processing (2)

• en/docs/reference/config-catalog.md
• en/tools/config-catalog-generator/data/configs.json

📝 Walkthrough

Walkthrough

Adds WebSocket Proxy Profiles documentation for routing outbound ws and wss backend connections through HTTP CONNECT proxies. It documents matching, bypass rules, authentication, WSS TLS behavior, configuration examples, limitations, and configuration catalog entries. The WebSocket creation guide now links to this documentation, and the new page is added to the MkDocs navigation. The configuration catalog also receives wording corrections and tab wiring updates.

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	Only the Purpose section is provided; the template’s required Goals, Approach, Release note, Documentation, and other sections are missing.	Fill in the remaining template sections, including Goals, Approach, User stories, Release note, Documentation, Security checks, and Test environment, with issue links where applicable.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly matches the main change: adding documentation for WebSocket Proxy Profiles.
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.}