microsoft / microsoft/OpenAPI.NET.OData

add dynamicRef/generic support for collections when openapi 3.1 is supported

Đang mở
#461 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.

blocked type:enhancement
Ngôn ngữ chính
C#
Star
240
Fork
70
Merge trung bình
7 giờ 59 phút
Pull request đã merge (30 ngày)
13

Mô tả

today we implement collections as:

  • BaseCollectionResponse (Odata next link field, etc...)
  • BaseCounCollectionResponse (inherits from the previous, add the count field)
  • A lot of Users/Groups/Sites/...Collection response (inherits from one of the previous, adds the value property)

With the advent of OpenAPI 3.1 support we could get rid of all the UsersCollectionResponse schemas (about 4k in v1) and make the base types generic.

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 việc xem xét quá trình tạo response schema cho collection và hỗ trợ OpenAPI 3.1 của repository. Xác định các kiểu collection cơ sở tổng quát và hành vi của dynamicRef, sau đó kiểm tra để bảo đảm tài liệu được tạo không còn cần nhiều collection schema dành riêng cho từng resource.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
csharp
Lĩnh vực
api
Loại issue
Tính năng
Độ khó
5/5
Thời gian dự kiến
Hơn một tuần
Mức độ hoạt động
Đình trệ
Độ rõ ràng
Cần làm rõ
Mức phù hợp với người mới
30/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.