OpenAPITools / OpenAPITools/openapi-diff

Operations are detected as changed when comparing for open api version 3.0.1 and 3.1.0

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

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

OpenAP 3.1.0 Support
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ả

By comparing the two definitions attached the only difference is the open api version (3.0.1 against 3.1.0)

sample-api_3.47.0_ALL.json
sample-api_3.48.0_ALL.json

The operations are detected as changed and only repeat the parameters e.g. query, sort request parameters in one case, path parameters in the others) while nothing has changed in the operations.

testDiff.html

If we change the open api version in one definition to match the other, no changes are detected as expected

Report was generated by using the example code in home page by specifying rendering all changes i.e.
HtmlRender htmlRender = new HtmlRender("Changelog", "http://deepoove.com/swagger-diff/stylesheets/demo.css", true);

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

Bắt đầu với hai định nghĩa JSON OpenAPI đính kèm và tái tạo báo cáo bằng ví dụ homepage, với HtmlRender được cấu hình để hiển thị tất cả các thay đổi. So sánh đầu ra diff của operation và parameter khi chỉ phiên bản OpenAPI thay đổi. Được xem là hoàn tất khi phép so sánh chỉ thay đổi phiên bản không báo cáo bất kỳ thay đổi operation hoặc parameter nào, như được thể hiện trong testDiff.html.

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

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.