OpenAPITools / OpenAPITools/openapi-diff
Wrong changelog generated when having objects with same field name
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- Java
- Star
- 1.1k
- Fork
- 190
- Chỉ số merge pull request
- Không có pull request nào được merge trong 30 ngày
Mô tả
Lets say that the old and the new OpenAPI schemas have classes Object1 and Object2, both of which have a field myField1 without changes in-between the openapi schemas. If Obejct1.myField1 has different description than Object2.myField1, that would be detected as a change and printed in the output diff file.
Also, can you add some kind of configuration that would prevent the library to print such non-breaking changes (i.e. changed description is not a breaking change) ?
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 phép so sánh với các schema OpenAPI cũ và mới chứa Object1.myField1 và Object2.myField1, trong đó chỉ phần mô tả của chúng khác nhau. Truy vết điểm vào của quá trình tạo diff changelog và xác minh lý do các trường được ghép khớp giữa các object. Hoàn tất khi các trường không thay đổi không còn tạo ra thay đổi giả và hành vi cấu hình để loại bỏ các thay đổi mô tả không gây mất tính tương thích ngược được xác định.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- java, openapi
- Lĩnh vực
- api
- 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