Router schema leaves Kling callback_url / external_task_id descriptions self-contradictory

Đang mở Phù hợp với người mới
  • Có gì không ổn?
#2,204 1 bình luận 1 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
66/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
json, markdown
Lĩnh vực
api, documentation

Hướng nghiên cứu

Bắt đầu từ router-schemas/kling/kling-3.0-turbo.json và định nghĩa dùng chung KlingV2Options, nơi mô tả của callback_url và external_task_id chứa các câu mâu thuẫn. Kiểm tra các schema Kling liên quan tái sử dụng KlingV2Options để mọi bản sao đều được cập nhật. Hoàn thành khi cả hai mô tả đều nêu rằng trường này không được chuyển tiếp, Router thực hiện polling thay cho người gọi, và ID yêu cầu của Router là khóa truy vấn, không còn cam kết nào về callback hoặc tra cứu theo ID tùy chỉnh.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.

Ngôn ngữ chính
MDX
Star
315
Fork
218
Merge trung bình
21 giờ 28 phút
Pull request đã merge (30 ngày)
261

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của Comfy-Org/docs

Tất cả issue của Comfy-Org/docs

Issue tương tự

Thêm issue về Backend & API Design

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.