OpenAPITools / OpenAPITools/openapi-diff

ExtensionDiff in renderers (just tried console and html)

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

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

enhancement Render capabilities
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ả

I'm implementing ExtensionDiffs, but it seems they don't make it into the renderers, or at least I don't see how they would.
I.e. I'm only using console and html.

The console renderer just lists the route as changed and says there were backward incompatible changes in the spec but no further detail.

The html renderer lists the route under "What's Changed" with an empty <ul> with class detail which then renders as a thick gray line.

It would be nice if the renderers would be able to display details about the extension differences, especially when they are breaking, but also the non-breaking ones would be interesting.

In the html renderer result there is not even an indication whether there were breaking changes or not if the breaking changes come from an extension diff.

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 bằng cách lần theo ExtensionDiff từ đầu ra so sánh đến các trình kết xuất console và HTML, tập trung vào việc kết xuất thay đổi route và danh sách chi tiết hiện có. Hoàn thành khi cả hai trình kết xuất đều hiển thị chi tiết về các khác biệt của extension và cho biết các khác biệt đó là breaking hay non-breaking.

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
Tính năng
Độ 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
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.