OpenAPITools / OpenAPITools/openapi-diff

No backward compatible changes in Schema are marked as Compatible

Đang mở
#611 0 bình luận 4 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Breaking/Non-Breaking classification
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ả

Hello, Thanks alot for this great library. I am testing this library and found the following bugs when comparing Schemas,

Library version: 'org.openapitools.openapidiff:openapi-diff-core:2.1.0-beta.8'

  1. Removing an attribute from a Model is a non-backward compatible change, but It is marked as COMPATIBLE.
  2. Updating description of an attribute is a Metadata change but this is also marked as COMPATIBLE

After several tests, I deduced, The current version is able to detect any change in schema models, but all changes are marked as COMPATIBLE. I think the compatibility checks including metadata change checks are missing.

Please have a look and provide a roadmap when this feature can be fixed. Thanks alot for all the effort and excellent work.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. 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.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Tái hiện các phép so sánh đã được báo cáo với openapi-diff-core 2.1.0-beta.8, tập trung vào việc xóa thuộc tính schema và các thay đổi trong mô tả thuộc tính. Truy vết các bước kiểm tra tính tương thích của schema; được xem là hoàn tất khi các thuộc tính model bị xóa được báo cáo là không tương thích và các thay đổi chỉ liên quan đến mô tả được phân loại là thay đổi metadata thay vì tương thích.

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
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

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.