openapi-generators / openapi-generators/openapi-python-client
Handle "empty" default values as null
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
"empty" default values for optional fields throw an error. swagger-parser explicitly allows these (even though they are technically out-of-spec) by converting them silently to null. So, there exist openapi json in the wild built by swagger tools that pass swagger validation, but throw an error here in openapi-python-client.
OpenAPI Spec File
https://www.marinespecies.org/rest/api-docs/openapi.yaml
grep for:
schema:
type: integer
default: ""
There are three endpoints that have this property. One of which is AphiaTaxonRanksByID. It might be useful to check this endpoint out in the swagger docs here.
Desktop (please complete the following information):
- openapi-python-client version 0.28.0
Additional context
I am in contact with the folks at WORMS to try and find out how their openapi.yaml got this way. Will update here when I get more info.
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 với tệp OpenAPI về các loài sinh vật biển được liên kết trong issue, đặc biệt là các schema chứa type: integer và default: "". Theo dõi cách các giá trị mặc định của trường tùy chọn được xử lý trong quá trình tạo client và so sánh hành vi này với cách xử lý swagger-parser đã nêu. Được xem là hoàn tất khi các endpoint bị ảnh hưởng được tạo thành công và các giá trị mặc định rỗng được xử lý như null.
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
- backend-api-design, devtools
- Loại issue
- Lỗi
- Độ khó
- 3/5
- Thời gian dự kiến
- 1-2 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
- 45/100