OpenAPITools / OpenAPITools/openapi-diff

false positive for type if only the format is changed.

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

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ả

i changed the format of a string property.
e.g. when generated out of java and the propery is now mapped via Spring from a String to a UUID.

Perhaps it's correct to report a change. but the change is not on the type but on the format.
and therefore userUid (string -> string) does not help.

old

"ServicePageInteractionRequest":{
   "type":"object",
   "properties":{
      "userUid":{
         "type":"string"
      },
      ...
   }
}

new

"ServicePageInteractionRequest" : {
   "type" : "object",
   "properties" : {
      "userUid" : {
         "type" : "string",
         "format" : "uuid",
         "example" : "5412185d-2cf1-46d0-85d3-50bfc93b1122"
       },
      ...
   }
}

report:

Changed property type: userUid (string -> string)

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

Không có tệp mã nguồn hoặc bài kiểm thử nào được nêu. Hãy bắt đầu bằng cách lần theo đường dẫn so sánh và báo cáo phát ra “Changed property type”, sau đó tái hiện thay đổi định dạng String-to-UUID đã cung cấp. Công việc được hoàn tất khi các thay đổi chỉ về định dạng không còn tạo ra báo cáo kiểu string-to-string gây hiểu nhầm, với một bài kiểm thử hồi quy bao quát ví dụ này.

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ó
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
42/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.