docs(router): move the Router pages to the /v2/models namespace (cloud@9e788a8) - #1536
Merged
Merged
Conversation
…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.
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Comment |
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
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.
Summary
Comfy Router's model routes moved from
/v1/modelsto/v2/modelsupstream (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 thecomfy-pr-botsync atcloud@9e788a8(#1535) onto the consolidated pages indocs/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 perAGENTS.md.limitations.mdx: routes are/v2/models; the "No way to resume a call you lost" section gains thedeadline_exceeded504+Retry-Afterbehaviour 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-Afternot declared on therate_limited429).reference.mdx: generated file, byte-identical to the bot's:/v2/modelsroutes, theIdempotency-Keyparameter,400/401/409/413response rows,Idempotent-Replayedheader, rewrittenRetry-Afterheader, extendedinvalid_inputandconcurrency_limit_exceededbuckets.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, withtranslationSourceHash/translationBlockHashesre-stamped from the new English files via the repo'schunked-translate.tshelpers (getSectionSyncStatusreportsupToDate: truefor 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/v1and 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./v1/left in any Router page; no em dashes in the two hand-written English pages.