Router schema leaves Kling callback_url / external_task_id descriptions self-contradictory

Abierto Apto para principiantes
  • ¿Algo no está bien?
#2,204 1 comentario 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
66/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
json, markdown
Área
api, documentation

Línea de trabajo

Empieza en router-schemas/kling/kling-3.0-turbo.json y en la definición compartida KlingV2Options, donde las descripciones de callback_url y external_task_id contienen las frases contradictorias. Revisa los esquemas de Kling hermanos que reutilizan KlingV2Options para que se actualice cada copia. Está terminado cuando ambas descripciones indican que el campo no se reenvía, que Router consulta en nombre del llamante y que el ID de solicitud de Router es la clave de consulta, sin que quede ninguna promesa de callback o de búsqueda por ID personalizado.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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.

Lenguaje dominante
MDX
Estrellas
315
Forks
218
Merge medio
21 h 28 min
PR fusionados (30 d)
261

Preparar el entorno

Este proyecto no incluye contenedor de desarrollo, Dockerfile ni guía de contribución, así que la configuración corre por tu cuenta: empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de Comfy-Org/docs

Todos los issues de Comfy-Org/docs

Issues similares

Más issues de Backend & API Design

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.