Add Documentation for WebSocket Proxy Profiles#11583
Conversation
|
Warning Review limit reached
Next review available in: 54 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the 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 configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughAdds WebSocket Proxy Profiles documentation for routing outbound Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
hisanhunais
force-pushed
the
websocket-proxy-support
branch
from
f326d06 to
8d8b06c
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
en/tools/config-catalog-generator/data/configs.json (1)
4504-4550: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winUse empty strings/tags for parameters without a default value. Based on learnings, config catalog parameters with no default value should be displayed with an empty
<code></code>tag.
en/tools/config-catalog-generator/data/configs.json#L4504-L4550: Replace the"-"values with""for thedefaultproperties of thews.proxy_profileparameters.en/tools/config-catalog-generator/data/configs.json#L4565-L4611: Replace the"-"values with""for thedefaultproperties of thewss.proxy_profileparameters.en/docs/reference/config-catalog.md#L12030-L12135: Replace the<code>-</code>content with empty<code></code>tags for the renderedws.proxy_profiledefault values.en/docs/reference/config-catalog.md#L12205-L12310: Replace the<code>-</code>content with empty<code></code>tags for the renderedwss.proxy_profiledefault values.Source: Learnings
🤖 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/tools/config-catalog-generator/data/configs.json`:
- Line 1586: Correct the application_sharing_impl description by adding the
missing period and space before “If it is saml” in
en/tools/config-catalog-generator/data/configs.json lines 1586-1586 and apply
the identical text correction in en/docs/reference/config-catalog.md lines
4243-4243.
🪄 Autofix (Beta)
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
Run ID: de1b19df-edf4-4753-b880-ee740200fdb3
📒 Files selected for processing (5)
en/docs/api-design-manage/design/create-api/create-streaming-api/create-a-websocket-streaming-api.mden/docs/api-gateway/websocket-proxy-profiles.mden/docs/reference/config-catalog.mden/mkdocs.ymlen/tools/config-catalog-generator/data/configs.json
🚧 Files skipped from review as they are similar to previous changes (2)
- en/docs/api-design-manage/design/create-api/create-streaming-api/create-a-websocket-streaming-api.md
- en/docs/api-gateway/websocket-proxy-profiles.md
| "default": "If the config is not mentioned, then undefined.default", | ||
| "possible": "default, saml", | ||
| "description": "Use the application_sharing_impl as default implmentationIf it is saml, the group extractor extracts the claims to group the applications from the saml response." | ||
| "description": "Use the application_sharing_impl as default implementationIf it is saml, the group extractor extracts the claims to group the applications from the saml response." |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Fix typographical error in application_sharing_impl description. Both files contain a missing period and space before "If it is saml" in the text.
en/tools/config-catalog-generator/data/configs.json#L1586-L1586: Fix the missing period and space to read "implementation. If it is saml".en/docs/reference/config-catalog.md#L4243-L4243: Apply the same typographical fix to the rendered HTML paragraph.
📍 Affects 2 files
en/tools/config-catalog-generator/data/configs.json#L1586-L1586(this comment)en/docs/reference/config-catalog.md#L4243-L4243
🤖 Prompt for 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.
In `@en/tools/config-catalog-generator/data/configs.json` at line 1586, Correct
the application_sharing_impl description by adding the missing period and space
before “If it is saml” in en/tools/config-catalog-generator/data/configs.json
lines 1586-1586 and apply the identical text correction in
en/docs/reference/config-catalog.md lines 4243-4243.
2 participants
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: