Skip to content

chore: sync vendored Comfy API v2 spec (cloud@5a3b668) - #107

Closed
comfy-pr-bot wants to merge 1 commit into
mainfrom
chore/sync-v2-spec
Closed

comfy-pr-bot wants to merge 1 commit into
mainfrom
chore/sync-v2-spec

Conversation

@comfy-pr-bot

@comfy-pr-bot comfy-pr-bot commented Aug 27, 2026

Copy link
Copy Markdown
Member

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

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 bash scripts/gen_models.sh 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.

@comfy-pr-bot
comfy-pr-bot requested review from a team as code owners August 27, 2026 23:23
@coderabbitai

coderabbitai Bot commented Aug 27, 2026

Copy link
Copy Markdown

Review Change StackReview Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Advanced

Run ID: 7d984091-1f40-403b-a3ab-d37366caae83

📥 Commits

Reviewing files that changed from the base of the PR and between 3702e6f and 5d35330.

📒 Files selected for processing (2)
  • spec/openapi.yaml
  • src/comfy_low/models/_generated.py

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The OpenAPI contract now defines captured job-log retrieval, the JobLogs model, optional log links, session-token metadata, SSE reconciliation semantics, and clarified output node identifiers. Generated Python models reflect the new log entities and metadata.

Changes

Job logs contract

Layer / File(s) Summary
Job logs API contract
spec/openapi.yaml
Adds GET /api/v2/jobs/{id}/logs, the JobLogs schema, and the optional JobUrls.logs link.
Generated log models
src/comfy_low/models/_generated.py
Adds the JobLogs model and the optional JobUrls.logs property.
Related contract clarifications
spec/openapi.yaml, src/comfy_low/models/_generated.py
Documents session-token handling, SSE log reconciliation, and empty Output.node_id values.

Priority: ➖ Normal

Estimated code review effort: 3 (Moderate) | ~25 minutes

Change: Feature

Suggested reviewers: wei-hai

Merge Risk: ⚪ Minimal · up to ab83b

The synchronized API contract and generated models are consistent; no actionable merge-blocking risk remains.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the main change as synchronizing the vendored Comfy API v2 specification. The referenced upstream commit differs from the PR objective, but this does not make the title un…
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/sync-v2-spec

Comment @coderabbitai help to get the list of available commands.

@comfy-pr-bot comfy-pr-bot changed the title chore: sync vendored Comfy API v2 spec (cloud@f2cb906) chore: sync vendored Comfy API v2 spec (cloud@941d631) Aug 28, 2026
@comfy-pr-bot comfy-pr-bot changed the title chore: sync vendored Comfy API v2 spec (cloud@941d631) chore: sync vendored Comfy API v2 spec (cloud@0499481) Sep 1, 2026
@comfy-pr-bot comfy-pr-bot changed the title chore: sync vendored Comfy API v2 spec (cloud@0499481) chore: sync vendored Comfy API v2 spec (cloud@3067dbc) Sep 1, 2026
@comfy-pr-bot comfy-pr-bot changed the title chore: sync vendored Comfy API v2 spec (cloud@3067dbc) chore: sync vendored Comfy API v2 spec (cloud@e57bc53) Sep 3, 2026
@comfy-pr-bot comfy-pr-bot changed the title chore: sync vendored Comfy API v2 spec (cloud@e57bc53) chore: sync vendored Comfy API v2 spec (cloud@1a8664d) Sep 3, 2026
@comfy-pr-bot comfy-pr-bot changed the title chore: sync vendored Comfy API v2 spec (cloud@1a8664d) chore: sync vendored Comfy API v2 spec (cloud@e67e251) Sep 5, 2026
@comfy-pr-bot comfy-pr-bot changed the title chore: sync vendored Comfy API v2 spec (cloud@e67e251) chore: sync vendored Comfy API v2 spec (cloud@ba8f414) Sep 9, 2026
@comfy-pr-bot comfy-pr-bot changed the title chore: sync vendored Comfy API v2 spec (cloud@ba8f414) chore: sync vendored Comfy API v2 spec (cloud@67c8636) Sep 9, 2026
@comfy-pr-bot
comfy-pr-bot force-pushed the chore/sync-v2-spec branch 2 times, most recently from ed32619 to 5d35330 Compare September 11, 2026 22:51
@comfy-pr-bot comfy-pr-bot changed the title chore: sync vendored Comfy API v2 spec (cloud@67c8636) chore: sync vendored Comfy API v2 spec (cloud@d0db749) Sep 11, 2026
@comfy-pr-bot comfy-pr-bot changed the title chore: sync vendored Comfy API v2 spec (cloud@d0db749) chore: sync vendored Comfy API v2 spec (cloud@f648e5d) Sep 12, 2026
@comfy-pr-bot comfy-pr-bot changed the title chore: sync vendored Comfy API v2 spec (cloud@f648e5d) chore: sync vendored Comfy API v2 spec (cloud@95e9271) Sep 13, 2026
@comfy-pr-bot comfy-pr-bot changed the title chore: sync vendored Comfy API v2 spec (cloud@95e9271) chore: sync vendored Comfy API v2 spec (cloud@4dc6e93) Sep 14, 2026
@comfy-pr-bot comfy-pr-bot changed the title chore: sync vendored Comfy API v2 spec (cloud@4dc6e93) chore: sync vendored Comfy API v2 spec (cloud@5a3b668) Sep 14, 2026
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 14, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants