Skip to content

docs: drop comfy-swift-sdk from the v2 client list - #35

Merged
wei-hai merged 1 commit into
mainfrom
fix/swift-sdk-not-v2
Jul 30, 2026
Merged

docs: drop comfy-swift-sdk from the v2 client list#35
wei-hai merged 1 commit into
mainfrom
fix/swift-sdk-not-v2

Conversation

@wei-hai

@wei-hai wei-hai commented Jul 30, 2026

Copy link
Copy Markdown
Collaborator

The Related projects table 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-sdk declares the endpoints it depends on in Scripts/contract/sdk-endpoints.yml, whose own header says they are "validated against the ComfyUI front-facing OpenAPI contract (Comfy-Org/ComfyUI : openapi.yaml)":

Method Path
POST /api/prompt
GET /api/queue
POST /api/jobs/{job_id}/cancel
GET /api/view
POST /api/upload/image
GET /api/jobs/{job_id}

None of those are /api/v2/*. The Python SDK, the TypeScript SDK, and comfy-api-proxy all speak /api/v2/ (see their spec/openapi.yaml and transport layers).

So the two are different contracts that happen to both reach Comfy Cloud.

Fix

Drops the comfy-swift-sdk row 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 into comfy-python-sdk, comfy-typescript-sdk, and comfy-swift-sdk; this is one of three matching PRs.

Note the claim already shipped in comfy-sdk 0.1.5 (PyPI) and @comfyorg/sdk 0.1.5 (npm), since the README is the package long-description. It will correct itself on the next release of each.

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.
@wei-hai
wei-hai requested review from a team as code owners July 30, 2026 21:17
@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@wei-hai, 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: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 83237d3a-0997-44ec-bb2e-b5a97fc4a0cf

📥 Commits

Reviewing files that changed from the base of the PR and between fa866b8 and f86e224.

📒 Files selected for processing (1)
  • README.md

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.

@wei-hai
wei-hai merged commit 7a22f70 into main Jul 30, 2026
10 checks passed
@wei-hai
wei-hai deleted the fix/swift-sdk-not-v2 branch July 30, 2026 21:18
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