OpenAPITools / OpenAPITools/openapi-diff

In openapi-diff-cli add old and new filenames to the output

Đang mở Phù hợp với người mới
#506 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.

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

When using openapi-diff-cli we need to give and filenames.
It will be cool to have those filenames in the report output.

Before:

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                           API Name API
--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
...

After:

==========================================================================
==                            API CHANGE LOG                            ==
==========================================================================
                           API Name API
--------------------------------------------------------------------------
old file: xxx.json
new file: yyy.json
--------------------------------------------------------------------------
--                            What's Changed                            --
--------------------------------------------------------------------------
...

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 từ điểm vào của đầu ra báo cáo openapi-diff-cli và theo dõi cách tên tệp của đầu vào cũ và mới được truyền vào quá trình tạo báo cáo. Chạy CLI với các đầu vào JSON cũ và mới của issue, sau đó xác minh rằng báo cáo bao gồm cả hai tên tệp trong phần được hiển thị mà không thay đổi nhật ký thay đổi hiện có.

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, cli
Loại issue
Tính năng
Độ khó
2/5
Thời gian dự kiến
1-3 giờ
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
68/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.