[PR #35] [MERGED] docs: drop comfy-swift-sdk from the v2 client list #43

New issue

Closed

opened 2026-10-31 22:00:58 +00:00 by bsakaguchi · 0 comments

bsakaguchi commented

2026-10-31 22:00:58 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-python-sdk/pull/35
Author: @wei-hai
Created: 7/30/2026
Status: ✅ Merged
Merged: 7/30/2026
Merged by: @wei-hai

Base: main ← Head: fix/swift-sdk-not-v2

📝 Commits (1)

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

📊 Changes

1 file changed (+0 additions, -1 deletions)

View changed files

📝 README.md (+0 -1)

📄 Description

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.

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Comfy-Org/comfy-python-sdk/pull/35 **Author:** [@wei-hai](https://github.com/wei-hai) **Created:** 7/30/2026 **Status:** ✅ Merged **Merged:** 7/30/2026 **Merged by:** [@wei-hai](https://github.com/wei-hai) **Base:** `main` ← **Head:** `fix/swift-sdk-not-v2` --- ### 📝 Commits (1) - [`f86e224`](https://github.com/Comfy-Org/comfy-python-sdk/commit/f86e224a454888ff21b897b7f2bb40be2ff9f63f) docs: drop comfy-swift-sdk from the v2 client list ### 📊 Changes **1 file changed** (+0 additions, -1 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+0 -1) </details> ### 📄 Description 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`](https://github.com/Comfy-Org/comfy-swift-sdk/blob/main/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. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 22:00:58 +00:00