Skip to content

docs(router): move the Router pages to the /v2/models namespace (cloud@9e788a8) - #1536

Merged
comfyui-wiki merged 1 commit into
docs/comfy-router-docsfrom
docs/router-v2-namespace
Aug 28, 2026
Merged

docs(router): move the Router pages to the /v2/models namespace (cloud@9e788a8)#1536
comfyui-wiki merged 1 commit into
docs/comfy-router-docsfrom
docs/router-v2-namespace

Conversation

@mattmillerai

Copy link
Copy Markdown
Contributor

Summary

Comfy Router's model routes moved from /v1/models to /v2/models upstream (Comfy-Org/cloud #7646, BE-9925), and the idempotency contract (Idempotency-Key, 409, Idempotent-Replayed, Retry-After) is now declared in the spec (cloud #7655). This PR brings the Router section up to that contract by carrying the comfy-pr-bot sync at cloud@9e788a8 (#1535) onto the consolidated pages in docs/comfy-router-docs (#1508).

Targets docs/comfy-router-docs, the branch that owns the Router pages, so it lands as one commit on #1508. Kept separate from the partner-model Code page pilot (#1533).

Details

English (api-reference/comfy-router/):

  • quickstart.mdx: every route and URL is /v2/models; new section Retrying safely with your own key (bring your own key, persist before send, the retry outcome table, a persist-then-call Python sample, and the billing-not-delivery note). Cross-links rewritten to /api-reference/comfy-router/...; em dashes removed per AGENTS.md.
  • limitations.mdx: routes are /v2/models; the "No way to resume a call you lost" section gains the deadline_exceeded 504 + Retry-After behaviour and links to the new quickstart section; the note that said the idempotency headers were "not yet in the generated contract" now says they are in the contract, with the one remaining gap (Retry-After not declared on the rate_limited 429).
  • reference.mdx: generated file, byte-identical to the bot's: /v2/models routes, the Idempotency-Key parameter, 400/401/409/413 response rows, Idempotent-Replayed header, rewritten Retry-After header, extended invalid_input and concurrency_limit_exceeded buckets.
  • openapi-v2.yaml: unchanged (the bot's copy is already identical to what docs: add Comfy Router API docs and register in navigation (consolidating comfy-pr-bot sync PRs) #1508 carries).

Locales (ja/, zh/, ko/): the same changes hand-applied to the three Router pages in each language, with translationSourceHash / translationBlockHashes re-stamped from the new English files via the repo's chunked-translate.ts helpers (getSectionSyncStatus reports upToDate: true for all nine files). Known pre-existing gap unchanged: the ko reference's "Error buckets" section is still English.

Method: 3-way merge (git merge-file) of bot(2a369ae, the last consolidated sync) to bot(9e788a8) onto #1508's adapted files, then the usual #1508 adaptations (nested links, em dashes). Once this merges, #1535 can be closed as superseded and added to #1508's source list.

ELI5

The Router API's addresses changed from /v1/models/... to /v2/models/..., and the retry-safety header it supports is now officially part of its contract. The docs still said /v1 and still said the header was unofficial. This PR updates every Router page (English, Japanese, Chinese, Korean) to the new addresses, adds a section on how to retry safely, and refreshes the generated reference so it matches the live spec.

Testing

  • npx mint broken-links: no broken links.
  • ## section counts match English in all nine locale files (10 / 10 / 5); hash re-stamp verified by reproducing the nine previously stamped hashes from HEAD before applying the new ones.
  • No /v1/ left in any Router page; no em dashes in the two hand-written English pages.

…d@9e788a8)

Comfy Router's model routes moved from /v1/models to /v2/models upstream
(cloud #7646) and the idempotency contract is now declared in the spec
(cloud #7655). This carries the comfy-pr-bot sync at cloud@9e788a8 (#1535)
onto the consolidated Router pages: every route in the quickstart, the
reference and the limitations page now reads /v2/models, the quickstart
gains the 'Retrying safely with your own key' section, the limitations page
reflects that Idempotency-Key, 409 and Idempotent-Replayed are in the
contract, and the generated reference picks up the new header, response
rows and error-bucket text. ja/zh/ko carry the same changes with their
translation hashes re-stamped.
@coderabbitai

coderabbitai Bot commented Aug 27, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: b2317e3a-cd60-4083-8e9b-e084a0e9b2f0

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

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

@mattmillerai mattmillerai added the cursor-review Trigger Cursor automated review label Aug 27, 2026
@github-actions
github-actions Bot deleted the branch docs/comfy-router-docs August 28, 2026 17:18
@github-actions github-actions Bot closed this Aug 28, 2026
@comfyui-wiki comfyui-wiki reopened this Aug 28, 2026
@comfyui-wiki
comfyui-wiki merged commit 433b8e9 into docs/comfy-router-docs Aug 28, 2026
11 checks passed
@github-actions
github-actions Bot deleted the docs/router-v2-namespace branch August 28, 2026 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cursor-review Trigger Cursor automated review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants