Router schema leaves Kling callback_url / external_task_id descriptions self-contradictory

未关闭 适合新手
  • 哪里不对？
#2,204 1 条评论 1 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
66/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
json, markdown
领域
api, documentation

调研方向

从 router-schemas/kling/kling-3.0-turbo.json 和共享的 KlingV2Options 定义开始，其中 callback_url 与 external_task_id 的描述包含相互矛盾的句子。检查复用 KlingV2Options 的同级 Kling 模式，确保每个副本都已更新。完成标准是：两个描述都说明该字段不会被转发，Router 代调用方轮询，并且 Router 请求 ID 是查询键，且不再保留任何关于回调或自定义 ID 查询的承诺。

由索引模型根据 Issue 内容生成。

描述

Where

router-schemas/kling/kling-3.0-turbo.json (and the sibling Kling schemas that share KlingV2Options) describe two fields as both functional and ignored:

  • components.schemas.KlingV2Options.properties.callback_url.description:
    "Callback notification URL for task results. The server notifies when the task status changes. Ignored: comfy-api drops this field before forwarding; Comfy Router polls on your behalf."
  • components.schemas.KlingV2Options.properties.external_task_id.description:
    "Customized Task ID. Does not overwrite the system-generated task ID but can be used for queries. Must be unique within a single user account. Ignored: comfy-api drops this field before forwarding; Comfy Router polls on your behalf."

Why it matters

The generated pages (development/comfy-router/models/kling/*/code.mdx and their zh/ja/ko translations) render both sentences, so a reader is told the server notifies on a callback URL that is never forwarded, and that a discarded custom ID can still be used for queries. Integrations that rely on either behavior will wait for a callback that never arrives or look up a task by an ID Router never received.

Suggested fix

In the schema source, drop the superseded promise and point to the Router flow instead: state that the field is not forwarded, that Router polls on the caller's behalf, and that the Router request ID is what to query with. Then let the schema sync regenerate the English pages and the i18n sync follow.

Found while reviewing the zh/ja/ko translation sync (PR #2202); the translations currently mirror the English source, which is where the contradiction comes from.

主要语言
MDX
星标
315
派生
218
平均合并
21 小时 28 分钟
30 天内合并 PR
261

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南，环境需要你自己搭建：先看它的 README，通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

Comfy-Org/docs 的其他 Issue

查看 Comfy-Org/docs 的全部 Issue

相似的 Issue

更多 Backend & API Design Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。