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

Reconsider closed enums for string values decoded from API responses

Abierto
  • ¿Algo no está bien?
#464 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 3 días

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
35/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Activo
Stack tecnológico
openapi, swift
Área
api, backend-api-design

Línea de trabajo

Start by reading the response-side enum examples and the four options in the issue, especially the 16 generated StatusPayload enums and Batch.StatusPayload. Compare how the Swift generator handles the proposed anyOf pattern with the Java and Python examples cited. The issue is done when a direction is chosen for existing and future response enums, including whether it applies generally or only to selected fields.

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

Descripción

swift-openapi-generator turns every string enum in the spec into a closed @frozen Swift enum. Many of these types are public, through Components.Schemas or typealiases such as ResponseObject.Status. That has different consequences for values we send and values we decode.

Values we send (request side)

When OpenAI adds a value, a closed enum costs two things:

  • The API-breakage check flags the new case, and we allowlist it with a changelog entry (as in c5d14f7). CONTRIBUTING already lists new enum cases as an accepted additive change.
  • Users can't send the new value until we regenerate and release.

Neither is a real problem.

Values we decode (response side)

If the API returns a value the enum doesn't know, decoding throws and the whole call fails. That would hit already-shipped apps, which no SDK release can fix. Examples:

  • ResponseObject.Status (Components.Schemas.Response.Value3Payload.StatusPayload)
  • Components.Schemas.Batch.StatusPayload, exposed directly by the Batch API (MacPaw/OpenAI#401)
  • 16 generated StatusPayload enums in total, plus other response-side enums

Java models every string enum as an open type: known constants plus an _UNKNOWN member, including Batch.Status. Python uses Literal types, which don't fail on unknown values at runtime.

Options

  1. Keep closed enums. This is what happens today. The risk is low per field, but a failure takes down every call that returns the field.
  2. Hand-written open types in Edited/ or Facade/. For example, a RawRepresentable struct with static constants for the fields that matter most, like statuses.
  3. Decode unknown values tolerantly. For example, a ParsingOptions flag or a custom init(from:) that maps unknown raw values to a fallback. This needs an unknown-style case, which generated enums don't have.
  4. Use the generator's open-enum pattern. Rewrite selected schemas in prepare_openapi.py as anyOf: [<enum>, {type: string}], which swift-openapi-generator turns into a struct with a known-value field and a raw-string fallback.

To decide

  • Whether response-side enums should be open in general, or only for selected fields such as statuses.
  • Which option to use, and whether it applies to existing types (a public API change) or only to new ones.
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.