Skip to content

chore: sync Comfy API v2 specification and Comfy Router pages (cloud@bf4ad8c) - #1937

Open
cloud-code-bot[bot] wants to merge 2 commits into
mainfrom
chore/sync-comfy-api-v2-spec
Open

cloud-code-bot[bot] wants to merge 2 commits into
mainfrom
chore/sync-comfy-api-v2-spec

Conversation

@cloud-code-bot

Copy link
Copy Markdown
Contributor

Automated sync of the public Comfy API v2 and Comfy Router specifications used by the generated API references, and of the Comfy Router API pages generated from the Comfy API contract. Source: cloud@bf4ad8c.

router-openapi.yaml is the public Comfy Router contract, projected from the same upstream contract the Router pages are generated from and the same projection the Router SDKs vendor (the Python and Swift copies byte-for-byte; the TypeScript SDK reformats its copy with oxfmt). It is GENERATED - edit the upstream contract, not this copy. If this is the first sync that carries it, it renders nothing until this repository gives it an openapi: navigation entry.

development/comfy-router/reference.mdx is GENERATED - edit the upstream contract, not this copy. It is regenerated on every sync and an edit made here is overwritten by the next one.

development/comfy-router/quickstart.mdx, development/comfy-router/limitations.mdx, development/comfy-router/pricing.mdx, development/comfy-router/higgsfield-byok.mdx and development/comfy-router/litellm.mdx are hand-written upstream and published verbatim. They are likewise overwritten on every sync, so edit them upstream. If this is the first sync that carries one of them, it also needs a navigation entry in this repository before it renders.

router-schemas/<provider>/<model>.json are the exact GET /v2/models/{id}/openapi.json documents for every model with an authored schema; the docs generator (.github/scripts/snippets/gen-code-pages.ts) reads them. They are GENERATED and the directory is MIRRORED on every sync, so a document removed upstream is removed here too - edit the upstream contract, not these copies.

development/comfy-router/models/**/code.mdx, the model index development/comfy-router/models.mdx, the serving-provider index development/comfy-router/providers.mdx and the docs.json entries for them are this repository's OWN derived output: the sync runs bun run code-pages:gen -- --prune over the documents above and commits the result, so code-pages is green as opened and no regen commit is needed on this branch. They are GENERATED and PRUNED - a page whose model left the catalog is deleted here too, and providers.mdx exists only while some model publishes an x-comfy-router-alt-providers leg.

This is the single rolling sync pull request for the published Comfy API v2 specification and Comfy Router pages. It lives on chore/sync-comfy-api-v2-spec, and every later upstream change force-updates that branch and refreshes this description with the new source commit — so there is only ever one open sync pull request here, and its diff is always the current one. Please do not push commits to this branch; the next sync would overwrite them (it checks first and fails rather than doing so silently).

The projection strips internal operations and non-public source annotations, and fails before this pull request can be created if a known internal marker survives. This pull request is never auto-merged and requires human review.

@coderabbitai

coderabbitai Bot commented Oct 12, 2026 •

Copy link
Copy Markdown

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: ASSERTIVE
  • Plan: Advanced
  • Run ID: fd1ebdcd-ab4a-4562-b177-cc8e319ab726

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@github-actions

Copy link
Copy Markdown
Contributor

🌐 i18n translation sync check

English docs changed in this PR. 9 files in 3 languages may not be synced yet. The automated translation workflow handles these updates. Expand a language to see the files.

Japanese (ja): 3 files
  • ja/development/comfy-router/models.mdx
  • ja/development/comfy-router/models/higgsfield/higgsfield-genjutsu-motion-transfer-v1-0/code.mdx
  • ja/development/comfy-router/models/higgsfield/higgsfield-genjutsu-motion-transfer-v1-0/code.mdx
Simplified Chinese (zh): 3 files
  • zh/development/comfy-router/models.mdx
  • zh/development/comfy-router/models/higgsfield/higgsfield-genjutsu-motion-transfer-v1-0/code.mdx
  • zh/development/comfy-router/models/higgsfield/higgsfield-genjutsu-motion-transfer-v1-0/code.mdx
Korean (ko): 3 files
  • ko/development/comfy-router/models.mdx
  • ko/development/comfy-router/models/higgsfield/higgsfield-genjutsu-motion-transfer-v1-0/code.mdx
  • ko/development/comfy-router/models/higgsfield/higgsfield-genjutsu-motion-transfer-v1-0/code.mdx

Local sync: npm run translate (see README: Automated translation)

@mintlify

mintlify Bot commented Oct 12, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
comfy 🟢 Ready View Preview Oct 12, 2026, 7:20 PM

💡 Tip: Enable Automations to automatically generate PRs for you.

This branch was successfully deployed

1 active deployment
staging — 6b19626c Deployed Oct 12, 2026 by mintlify[bot]
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