ParticipantResponse.name is required where the API definition marks it nullable, so a nameless participant fails to parse

Abierto Apto para principiantes
#134 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 5 días

@TheeCoderAhmed ya está trabajando en esto.

Desde el 29/10/2026.

  • #147 de @TheeCoderAhmed — abierto

Evaluación

Dificultad
1/5
Tiempo estimado
Menos de una hora
Aptitud para principiantes
86/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
python
Área
api

Línea de trabajo

Lee src/tac/models/conversation.py y la declaración de ParticipantResponse alrededor de las líneas 237–243; compara su campo name con la definición nullable y opcional citada en el issue. Comprueba las rutas de construcción de participants en src/tac/context/conversation.py y ejecuta las pruebas relevantes del model o del context. El trabajo estará terminado cuando las responses sin name o con valor null se analicen correctamente, mientras los demás campos obligatorios sigan siendo obligatorios.

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

Descripción

What differs

ParticipantResponse.name is a required, non-nullable str, where the canonical definition marks the field nullable and does not require it. A participant with no display name therefore raises ValidationError client-side on a response the API is entitled to send.

Verified against main today (2026-10-08) at 2c24bd988c. All line citations are for navigation only.

# src/tac/models/conversation.py:237-243
class ParticipantResponse(BaseModel):
    id: str = Field(..., description="Participant ID")
    conversation_id: str = Field(..., alias="conversationId", description="Conversation ID")
    account_id: str = Field(..., alias="accountId", description="Account ID")
    name: str = Field(..., description="Participant display name")

What the definition declares

twilio/twilio-oai spec/yaml/twilio_conversations_v2.yaml, schema conversations.v2.participant at 141f1201b5 (:422-445):

  • required: is id, conversationId, accountId — name is not in it
  • name is type: string with nullable: true

The other three required fields match the model exactly, so name is the only divergence in this class.

Consequence

create_participant, update_participant and list_participants all construct ParticipantResponse(**...) (src/tac/context/conversation.py:140, :204, :228). Any participant the service returns without a name — or with "name": null, which nullable: true permits — makes all three raise, so the caller cannot read a conversation's participants rather than reading them with name=None.

What the model should declare

name: str | None = Field(None, description="Participant display name"), matching the treatment profile_id, created_at and updated_at already get in the same class.

The TypeScript port has a milder instance of the same thing

Not a separate report, since the two SDKs track each other — twilio/twilio-agent-connect-typescript at c34450aa8c, packages/core/src/types/conversation.ts:316:

export const ConversationParticipantSchema = z.object({
  ...
  name: z.string().optional(),      // :316 — accepts missing, rejects null

.optional() admits undefined but not null, so an explicit "name": null fails ListParticipantsResponseSchema.parse. The same file already uses the right shape twice for exactly this reason, with the reason in the comment — :281 name: z.string().nullish(), // API returns null when not set and :304 channelId: z.string().nullish(), // API returns null when not set. .nullish() at :316 would make it consistent.

Context, and no urgency implied

Found while building an OpenAPI-driven client generator against the canonical twilio-oai specs and comparing its output with the hand-written SDKs. We are not blocked — nothing here needs a response on any timeline.

Lenguaje dominante
Python
Estrellas
17
Forks
11
Merge medio
5 d 19 h
PR fusionados (30 d)
6

Preparar el entorno

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 twilio/twilio-agent-connect-python

Todos los issues de twilio/twilio-agent-connect-python

Issues similares

Más issues de Python

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.