docs: drop comfy-swift-sdk from the v2 client list - #35
Conversation
The Swift SDK does not speak the Comfy API v2 contract, so listing it beside
the Python and TypeScript SDKs under "Clients for the same Comfy API v2
contract" implied a conformance that does not exist.
Per comfy-swift-sdk's own Scripts/contract/sdk-endpoints.yml, it targets the
ComfyUI front-facing API (/api/prompt, /api/queue, /api/view,
/api/upload/image, /api/jobs/{id}) validated against Comfy-Org/ComfyUI's
openapi.yaml — not /api/v2/*, which is what this SDK and comfy-api-proxy use.
Caught in review by @guill on comfy-api-proxy#15.
|
Warning Review limit reached
Next review available in: 38 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: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
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 |
The
Related projectstable added during the README-consistency pass claimed the Swift SDK is a client for the same Comfy API v2 contract. It is not.Evidence
comfy-swift-sdkdeclares the endpoints it depends on inScripts/contract/sdk-endpoints.yml, whose own header says they are "validated against the ComfyUI front-facing OpenAPI contract (Comfy-Org/ComfyUI : openapi.yaml)":/api/prompt/api/queue/api/jobs/{job_id}/cancel/api/view/api/upload/image/api/jobs/{job_id}None of those are
/api/v2/*. The Python SDK, the TypeScript SDK, andcomfy-api-proxyall speak/api/v2/(see theirspec/openapi.yamland transport layers).So the two are different contracts that happen to both reach Comfy Cloud.
Fix
Drops the
comfy-swift-sdkrow from the v2 client table. The table now lists only the projects that actually implement that contract.Provenance
My mistake — I added that row inferring the grouping from a Slack thread about repo naming rather than checking what each SDK actually calls. Caught in review by @guill on
comfy-api-proxy#15. The same wrong claim went intocomfy-python-sdk,comfy-typescript-sdk, andcomfy-swift-sdk; this is one of three matching PRs.Note the claim already shipped in
comfy-sdk0.1.5 (PyPI) and@comfyorg/sdk0.1.5 (npm), since the README is the package long-description. It will correct itself on the next release of each.