openapi-generators / openapi-generators/openapi-python-client
Generator creates enum property types that can collide with user-defined types, causing generation failures
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Python
- Estrellas
- 2k
- Forks
- 293
- Merge medio
- 34 min
- PR fusionados (30 d)
- 1
Descripción
Describe the bug
When the generator creates a new Python type to represent a schema property's enum type it can sometimes get unlucky by generating the name of a user-defined type that already exists in the schema.
When this happens, the generator gives up and issues a warning. The Python type for the enum property and the generated API client are only partially generated as a result. This warning manifests as a runtime error in the Python client when affected endpoints are accessed by the generated Python code. I have so far been unable to figure out any configuration-based way of working around the issue.
OpenAPI Spec File
This issue can be reproduced deterministically by running:
openapi-python-client generate --url https://raw.githubusercontent.com/EvanBacon/App-Store-Connect-OpenAPI-Spec/refs/heads/main/specs/3.6.0.json --overwrite
Relevant warning output is in the "Additional context" section below.
Desktop (please complete the following information):
- OS: macOS 15.1.1
- Python Version: 3.12.1
- openapi-python-client version 0.21.6
Additional context
We discovered this "in the wild" while attempting to generate a Python client for the Apple App Store Connect API.
When we ran the generator on version 3.6.0 of the App Store Connect OpenAPI schema, we saw this (among other) warnings:
Unable to process schema /components/schemas/Certificate:
Found conflicting enums named CertificateType with incompatible values.
Failure to process schema has resulted in the removal of:
/components/schemas/Certificate
/components/schemas/CertificatesWithoutIncludesResponse
/components/schemas/CertificatesResponse
/components/schemas/CertificateResponse
Schema(title=None, multipleOf=None, maximum=None, exclusiveMaximum=None, minimum=None, exclusiveMinimum=None, maxLength=None, minLength=None, pattern=None, maxItems=None, minItems=None, uniqueItems=None, maxProperties=None, minProperties=None, required=None, enum=['certificates'], const=None, type=<DataType.STRING: 'string'>, allOf=[], oneOf=[], anyOf=[], schema_not=None, items=None, prefixItems=[], properties=None, additionalProperties=None, description=None, schema_format=None, default=None, nullable=False, discriminator=None, readOnly=None, writeOnly=None, xml=None, externalDocs=None, example=None, deprecated=None)
This was happening because the generator was attempting to create a type called "CertificateType" when it was traversing the properties of the "Certificate" object, who had a child enum property called "type", excerpt below:
"Certificate": {
"type": "object",
"title": "Certificate",
"properties": {
"type": {
"type": "string",
"enum": [
"certificates"
]
The generator took the name of the parent, and concatenated it with the name of the property to create the name "CertificateType".
Sadly, as noted above, that type name was already taken in the API by a separate user-defined "CertificateType", excerpted below:
"CertificateType": {
"type": "string",
"enum": [
"IOS_DEVELOPMENT",
"IOS_DISTRIBUTION",
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Reproduce el fallo con el comando openapi-python-client generate proporcionado y el esquema de App Store Connect 3.6.0; después, sigue el proceso para determinar cómo el enum type del objeto Certificate se convierte en CertificateType y entra en conflicto con el tipo de esquema existente. Se considera completado cuando la generación ya no descarta los esquemas afectados ni produce un cliente que falle en tiempo de ejecución al acceder a esos endpoints.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- openapi, python
- Área
- tooling
- Tipo de issue
- Error
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100