[PR #104] [MERGED] chore: sync vendored Comfy API v2 spec (cloud@67c8636) #106

New issue

Closed

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

bsakaguchi commented

2026-10-31 22:04:37 +00:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Comfy-Org/comfy-typescript-sdk/pull/104
Author: @comfy-pr-bot
Created: 8/27/2026
Status: ✅ Merged
Merged: 9/10/2026
Merged by: @mattmillerai

Base: main ← Head: chore/sync-v2-spec

📝 Commits (4)

4fcdff2 chore: sync vendored Comfy API v2 spec from cloud@e67e251
2a6f5ef feat(jobs): add Job.getLogs() for the synced getJobLogs operation
8eb9d29 Merge remote-tracking branch 'origin/main' into chore/sync-v2-spec
ab12f61 fix: address bot review comments

📊 Changes

11 files changed (+493 additions, -7 deletions)

View changed files

📝 CHANGELOG.md (+16 -0)
📝 README.md (+27 -0)
📝 spec/openapi.yaml (+167 -2)
📝 src/low/generated/index.ts (+1 -1)
📝 src/low/generated/types.gen.ts (+84 -1)
📝 src/low/generated/zod.gen.ts (+23 -2)
📝 src/low/transport.test.ts (+38 -0)
📝 src/low/transport.ts (+33 -0)
📝 src/sdk/jobs.test.ts (+28 -0)
📝 src/sdk/jobs.ts (+22 -0)
📝 test/support/stub-server.ts (+54 -1)

📄 Description

Automated sync of the public Comfy API v2 spec,
projected from the canonical contract (internal notes stripped).
Source: cloud@67c8636.

It lands at spec/openapi.yaml and is a contract of its
own — it is never merged into another vendored spec in this repo.

This is the single rolling sync pull request for spec/openapi.yaml. It lives
on chore/sync-v2-spec, and every later change to the upstream contract
force-updates this same branch and refreshes this description with the
new source commit — so there is only ever one open sync PR for this
spec, and its diff is always the current one.

Please do not push commits to this branch: the next sync would
overwrite them. (It will not do so silently — the workflow checks the
branch first and fails, naming this pull request, if it finds a commit
it did not make.) Push follow-up work to a branch of your own instead.

No regen commit needed. This sync ran pnpm run generate against the
vendored spec and committed what it produced, so the generated low
layer in this pull request is already in step with
spec/openapi.yaml and this repository's spec-drift check should be green as
opened.

Green is not a substitute for reading the diff. The drift check
confirms only that the vendored spec and the generated low layer
agree with each other — it says nothing about whether either is what
the contract change meant, and the generated bytes were produced
upstream, by a generator this repository does not run. Review the
generated diff as you would any other.

Summary by CodeRabbit

New Features
- Added access to captured job execution logs through Job.getLogs().
- Logs include text, capture time, completion status, and truncation details.
- Jobs may now provide a direct logs link, with clear handling when no log is available.
- Added support for auth_token_comfy_org in job submission metadata.
Documentation
- Documented retrieving job logs, including empty logs, truncation, retention, terminal-state guidance, and access errors.
- Updated API documentation for the job logs endpoint and related response data.

_{🔄 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-typescript-sdk/pull/104 **Author:** [@comfy-pr-bot](https://github.com/comfy-pr-bot) **Created:** 8/27/2026 **Status:** ✅ Merged **Merged:** 9/10/2026 **Merged by:** [@mattmillerai](https://github.com/mattmillerai) **Base:** `main` ← **Head:** `chore/sync-v2-spec` --- ### 📝 Commits (4) - [`4fcdff2`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/4fcdff2e9155e5ea8ff2aab510ae72004a8462f9) chore: sync vendored Comfy API v2 spec from cloud@e67e251 - [`2a6f5ef`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/2a6f5efe20e20503bc0aaae7de4f9a15413e6c59) feat(jobs): add Job.getLogs() for the synced getJobLogs operation - [`8eb9d29`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/8eb9d29c9bcd9e197b6c7eb8cc111911426bf2ed) Merge remote-tracking branch 'origin/main' into chore/sync-v2-spec - [`ab12f61`](https://github.com/Comfy-Org/comfy-typescript-sdk/commit/ab12f61eee59b6fe08bb4adcedda82b38c84caae) fix: address bot review comments ### 📊 Changes **11 files changed** (+493 additions, -7 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+16 -0) 📝 `README.md` (+27 -0) 📝 `spec/openapi.yaml` (+167 -2) 📝 `src/low/generated/index.ts` (+1 -1) 📝 `src/low/generated/types.gen.ts` (+84 -1) 📝 `src/low/generated/zod.gen.ts` (+23 -2) 📝 `src/low/transport.test.ts` (+38 -0) 📝 `src/low/transport.ts` (+33 -0) 📝 `src/sdk/jobs.test.ts` (+28 -0) 📝 `src/sdk/jobs.ts` (+22 -0) 📝 `test/support/stub-server.ts` (+54 -1) </details> ### 📄 Description Automated sync of the public Comfy API v2 spec, projected from the canonical contract (internal notes stripped). Source: `cloud@67c8636`. It lands at `spec/openapi.yaml` and is a contract of its own — it is never merged into another vendored spec in this repo. This is the single rolling sync pull request for `spec/openapi.yaml`. It lives on `chore/sync-v2-spec`, and every later change to the upstream contract force-updates this same branch and refreshes this description with the new source commit — so there is only ever one open sync PR for this spec, and its diff is always the current one. Please do not push commits to this branch: the next sync would overwrite them. (It will not do so silently — the workflow checks the branch first and fails, naming this pull request, if it finds a commit it did not make.) Push follow-up work to a branch of your own instead. **No regen commit needed.** This sync ran `pnpm run generate` against the vendored spec and committed what it produced, so the generated low layer in this pull request is already in step with `spec/openapi.yaml` and this repository's spec-drift check should be green as opened. Green is not a substitute for reading the diff. The drift check confirms only that the vendored spec and the generated low layer agree with each other — it says nothing about whether either is what the contract change meant, and the generated bytes were produced upstream, by a generator this repository does not run. Review the generated diff as you would any other.  ## Summary by CodeRabbit * **New Features** * Added access to captured job execution logs through `Job.getLogs()`. * Logs include text, capture time, completion status, and truncation details. * Jobs may now provide a direct logs link, with clear handling when no log is available. * Added support for `auth_token_comfy_org` in job submission metadata. * **Documentation** * Documented retrieving job logs, including empty logs, truncation, retention, terminal-state guidance, and access errors. * Updated API documentation for the job logs endpoint and related response data.  --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>

bsakaguchi

2026-10-31 22:04:37 +00:00