Skip to content

chore: sync vendored Comfy API v2 spec (cloud@585fbea) #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wei-hai merged 2 commits into from
Jul 23, 2026
+23 −4
Merged

chore: sync vendored Comfy API v2 spec (cloud@585fbea) #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
68e8702
chore: sync vendored Comfy API v2 spec from cloud@585fbea
wei-hai Jul 23, 2026
7519c49
chore: regenerate low-level types for synced v2 spec
wei-hai Jul 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions spec/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -364,9 +364,7 @@ paths:
additionalProperties: true
extra_data:
type: object
description: "Optional typed extras submitted alongside the
workflow. Closed: only the enumerated properties are
accepted."
description: "Per-prompt ComfyUI `extra_data`, same shape as Comfy Cloud and local ComfyUI. Closed object: only the enumerated keys are accepted, keeping the contract fully typed. Forwarded to the worker per-prompt, never persisted, and excluded from idempotency comparison."
additionalProperties: false
properties:
api_key_comfy_org:
Expand Down Expand Up @@ -438,6 +436,8 @@ paths:
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/RateLimited"
"500":
$ref: "#/components/responses/UpstreamError"
/api/v2/jobs/{id}/events:
Expand Down Expand Up @@ -549,6 +549,8 @@ paths:
$ref: "#/components/responses/Forbidden"
"404":
$ref: "#/components/responses/NotFound"
"429":
$ref: "#/components/responses/RateLimited"
"500":
$ref: "#/components/responses/UpstreamError"
components:
Expand Down Expand Up @@ -617,6 +619,15 @@ components:
application/json:
schema:
$ref: "#/components/schemas/ErrorEnvelope"
RateLimited:
description: "`rate_limited` — the caller has exceeded the request rate limit for this account. Account/rate-scoped, not job-specific — this can be returned even for a job id the caller doesn't own or that doesn't exist, without revealing which."
headers:
Retry-After:
$ref: "#/components/headers/RetryAfter"
content:
application/json:
schema:
$ref: "#/components/schemas/ErrorEnvelope"
schemas:
Asset:
type: object
Expand Down
10 changes: 9 additions & 1 deletion src/low/generated/types.gen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ export type PostJobsData = {
[key: string]: unknown;
};
/**
* Optional typed extras submitted alongside the workflow. Closed: only the enumerated properties are accepted.
* Per-prompt ComfyUI `extra_data`, same shape as Comfy Cloud and local ComfyUI. Closed object: only the enumerated keys are accepted, keeping the contract fully typed. Forwarded to the worker per-prompt, never persisted, and excluded from idempotency comparison.
*/
extra_data?: {
/**
Expand Down Expand Up @@ -492,6 +492,10 @@ export type GetJobErrors = {
* `not_found`.
*/
404: ErrorEnvelope;
/**
* `rate_limited` — the caller has exceeded the request rate limit for this account. Account/rate-scoped, not job-specific — this can be returned even for a job id the caller doesn't own or that doesn't exist, without revealing which.
*/
429: ErrorEnvelope;
/**
* `upstream_error` — an unexpected failure reaching or processing the request in this implementation's backing services. The message is always a generic, safe-to-display string; implementation detail (the specific upstream, its error text, transport failures) is never included here — see each implementation's own error-mapping notes. Every operation in this contract can fail this way.
*/
Expand Down Expand Up @@ -578,6 +582,10 @@ export type CancelJobErrors = {
* `not_found`.
*/
404: ErrorEnvelope;
/**
* `rate_limited` — the caller has exceeded the request rate limit for this account. Account/rate-scoped, not job-specific — this can be returned even for a job id the caller doesn't own or that doesn't exist, without revealing which.
*/
429: ErrorEnvelope;
/**
* `upstream_error` — an unexpected failure reaching or processing the request in this implementation's backing services. The message is always a generic, safe-to-display string; implementation detail (the specific upstream, its error text, transport failures) is never included here — see each implementation's own error-mapping notes. Every operation in this contract can fail this way.
*/
Expand Down
Loading