openapi-generators / openapi-generators/openapi-python-client
Generator creates enum property types that can collide with user-defined types, causing generation failures
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Python
- Star
- 2k
- Fork
- 293
- Merge trung bình
- 34 phút
- Pull request đã merge (30 ngày)
- 1
Mô tả
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",
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Tái hiện lỗi bằng lệnh openapi-python-client generate được cung cấp và schema App Store Connect 3.6.0, sau đó truy vết cách enum type của đối tượng Certificate trở thành CertificateType và xung đột với kiểu schema hiện có. Được xem là hoàn tất khi quá trình sinh mã không còn loại bỏ các schema bị ảnh hưởng hoặc tạo ra một client bị lỗi khi chạy lúc các endpoint đó được truy cập.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- openapi, python
- Lĩnh vực
- tooling
- Loại issue
- Lỗi
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 35/100