Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

A number of types that are `Codable` don't encode correctly

Abierto
  • ¿Algo no está bien?
#379 1 comentario 1 reacción 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
4/5
Tiempo estimado
3-5 días
Aptitud para principiantes
38/100
Tipo de issue
Error
Claridad
Bastante claro
Estado de actividad
Estancado
Stack tecnológico
swift
Área
api

Línea de trabajo

Start with Sources/OpenAI/Public/Models/ChatQuery.swift, especially ChatQuery.ChatCompletionMessageParam, and identify other typed enums with the same encoding or decoding concern. Add round-trip tests for the affected types and verify that encoding then decoding returns the initial value.

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

Descripción

Describe the bug
A number of types that are Codable don't encode correctly. This seems to impact a number of the typed enums that are typically received from an OpenAI compatible server and that are not persisted by a client (unless the client would persist its requests)

For instance ChatQuery.ChatCompletionMessageParam would need a decoding such as

public init(from decoder: Decoder) throws {
    let container = try decoder.container(keyedBy: CodingKeys.self)
    let role = try container.decode(Role.self, forKey: .role)
    switch role {
    case .system:
        self = try .system(.init(from: decoder))
    case .developer:
      self = try .developer(.init(from: decoder))
    case .user:
      self = try .user(.init(from: decoder))
    case .assistant:
      self = try .assistant(.init(from: decoder))
    case .tool:
      self = try .tool(.init(from: decoder))
    }
}

I mostly look at the types in ChatQuery but typically you need to hand write the encoding / decoding for each typed enum as the generated conformances are not correct and only you know about the key used to determine which nested type is right.

As a side note, it could be helpful to have tests that validate that the encoding and decoding of those types gives back the initial value.

Lmk if you want a PR.

Lenguaje dominante
Swift
Estrellas
2.9k
Forks
519
Merge medio
4 d 9 h
PR fusionados (30 d)
13

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 MacPaw/OpenAI

Todos los issues de MacPaw/OpenAI

Issues similares

Más issues de Swift

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.