chore: sync Comfy API v2 specification and Comfy Router pages (cloud@333c22c) - #1676
Open
comfy-pr-bot wants to merge 1 commit into
Open
comfy-pr-bot wants to merge 1 commit into
comfy-pr-bot wants to merge 1 commit into
Conversation
🌐 i18n translation sync reminder@comfyui-wiki English documentation was updated in this PR. Please complete or schedule translation updates for the following files: Japanese (
|
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Automated sync of the public Comfy API v2 specification used by
the generated API reference, and of the Comfy Router API
pages generated from the Comfy API contract. Source:
cloud@333c22c.development/comfy-router/reference.mdxis GENERATED - edit the upstreamcontract, not this copy. It is regenerated on every sync and an
edit made here is overwritten by the next one.
development/comfy-router/quickstart.mdxanddevelopment/comfy-router/limitations.mdxare 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>.jsonare the exactGET /v2/models/{id}/openapi.jsondocuments for every model with anauthored schema; the docs generator
(
.github/scripts/snippets/gen-code-pages.ts) reads them. They areGENERATED 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 provider indexdevelopment/comfy-router/models.mdxand thedocs.jsonentries for them are this repository's OWN derived output: the sync
runs
bun run code-pages:gen -- --pruneover the documents above andcommits the result, so
code-pagesis green as opened and no regencommit is needed on this branch. They are GENERATED and PRUNED - a
page whose model left the catalog is deleted here too.
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 changeforce-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.