openapi-generators / openapi-generators/openapi-python-client
Endpoints are not created for routes with Pydantic model default values
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 attempting to generate the client for an endpoint containing a route with a default value represented by a Pydantic model, the client generation fails. Specifically, the issue arises when the default value is set as a Pydantic model, such as the example below:
from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class Cake(BaseModel):
slices: int
@app.post("/eat_cake")
async def eat_cake(cake: Cake | None = Cake(slices=20)):
return {"message": f"Eating {cake.slices} slices of cake!"}
The generated client results in the following error message:
Warning(s) encountered while generating. Client was generated, but some pieces may be missing
WARNING parsing POST /graph_study/{customer_name}/distinct_identities/distinct_to_base/eat_cake within default. Endpoint will not be generated.
Value {'slices': 20} is not valid, only None is allowed
This issue is caused by a condition not being met in the union.py file.
To Reproduce
- Define a FastAPI app with a route containing a Pydantic model with a default value.
- Attempt to generate the client using openapi-python-client version 0.17.2.
OpenAPI Spec File
{
"openapi": "3.0.2",
"info": {
"title": "FastAPI",
"version": "1.0"
},
"paths": {
"/cake_eater/eat_cake": {
"post": {
"summary": "Eat Cake",
"operationId": "eat_cake_cake_eater___eat_cake_post",
"requestBody": {
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"$ref": "#/components/schemas/Cake"
},
{
"type": "null"
}
],
"title": "Cake",
"default": {
"slices": 20
}
}
}
}
},
"responses": {
"200": {
"description": "Successful Response",
"content": {
"application/json": {
"schema": {}
}
}
},
"422": {
"description": "Validation Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HTTPValidationError"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"Cake": {
"properties": {
"slices": {
"type": "integer",
"title": "Slices"
}
},
"type": "object",
"required": [
"slices"
],
"title": "Cake"
},
"HTTPValidationError": {
"properties": {
"detail": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
},
"ValidationError": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
}
}
}
}
Desktop (please complete the following information):
- OS: Windows 11
- Python Version: 3.11.1
- openapi-python-client version 0.17.2
Additional context
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
Comienza en openapi_python_client/parser/properties/union.py alrededor de la línea 87 y reproduce el fallo con la especificación OpenAPI proporcionada o el ejemplo de FastAPI. Rastrea cómo se valida el valor predeterminado de la unión y, a continuación, verifica que el endpoint se genere correctamente en lugar de omitirse.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- fastapi, python
- Área
- api, devtools
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 45/100