Endpoints are not created for routes with Pydantic model default values
還沒有人認領這個 Issue。
評估
研究方向
從 openapi_python_client/parser/properties/union.py 第 87 行附近開始,使用提供的 OpenAPI 規格或 FastAPI 範例重現此失敗。追蹤 union 預設值的驗證方式,然後確認 endpoint 已成功產生,而不是被省略。
由索引模型根據 Issue 內容生成。
描述
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
- 主要語言
- Python
- 星號
- 2k
- 分支
- 293
- 平均合併
- 34 分鐘
- 30 天內合併 PR
- 1
貢獻指南
從這裡開始
- 先讀完整個 Issue,再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫,在一個分支上完成修改。
- 送出 Pull Request,並在描述裡引用這個 Issue 編號。
openapi-generators/openapi-python-client 的其他 Issue
-
難度 2/5 1-3 小時 新手友好度 68/100
-
難度 2/5 1-3 小時 新手友好度 65/100
-
難度 3/5 1-2 天 新手友好度 72/100
openapi-generators/openapi-python-client#1451 · 1 則留言 ·
-
難度 3/5 1-2 天 新手友好度 52/100
-
難度 3/5 1-2 天 新手友好度 64/100
openapi-generators/openapi-python-client#1435 · 1 則留言 ·
查看 openapi-generators/openapi-python-client 的全部 Issue
相似的 Issue
-
難度 2/5 1-3 小時 新手友好度 75/100
anthropics/skills#1811 · 1 則留言 ·
-
難度 2/5 1-3 小時 新手友好度 75/100
speaches-ai/speaches#678 ·
-
bug
難度 2/5 1-3 小時 新手友好度 75/100
datalayer/mcp-compose#42 ·
-
難度 2/5 1-3 小時 新手友好度 75/100
conda-forge/spacy-feedstock#177 ·
-
難度 2/5 1-3 小時 新手友好度 70/100
UKGovernmentBEIS/inspect_evals#2523 ·