microsoft / microsoft/OpenAPI.NET
Update SharpYaml dependency to v3.x
Chưa có ai nhận issue này.
- Ngôn ngữ chính
- C#
- Star
- 1.6k
- Fork
- 286
- Merge trung bình
- 6 giờ 38 phút
- Pull request đã merge (30 ngày)
- 35
Mô tả
Is your feature request related to a problem? Please describe.
OpenAPI.NET currently depends on SharpYaml v2. In my project, I use OpenAPI.NET to process OpenAPI documents and also need to read additional YAML-based configuration files.
SharpYaml v3 is a major redesign that introduces breaking changes compared to v2. Since OpenAPI.NET brings SharpYaml v2 as a dependency, I am currently forced to continue developing against the older SharpYaml API and plan a future migration.
Describe the solution you'd like
I would like OpenAPI.NET to update its SharpYaml dependency from v2 to the latest v3 release.
Describe alternatives you've considered
- Continuing to use SharpYaml v2 in my own code and migrating later.
- Isolating YAML processing behind an abstraction layer to minimize the impact of a future migration.
- Using a different YAML library for application-specific configuration files.
While these approaches are possible, they add complexity that could be avoided if OpenAPI.NET adopted SharpYaml v3 directly.
Hướng dẫn đóng góp
Bắt đầu từ đâu
- Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
- 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.
- Fork repository và làm thay đổi trên một nhánh.
- Mở pull request có tham chiếu số hiệu của issue.
Hướng nghiên cứu
Xác định khai báo dependency của project cho SharpYaml v2 và xem xét các breaking changes của SharpYaml v3 trước khi đánh giá việc xử lý YAML của OpenAPI bị ảnh hưởng. Chạy test suite hiện có sau khi cập nhật dependency; hoàn tất nghĩa là SharpYaml v3 được sử dụng và việc xử lý YAML của tài liệu OpenAPI vẫn tương thích.
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, yaml
- Lĩnh vực
- api
- Loại issue
- Tính năng
- Độ khó
- 4/5
- Thời gian dự kiến
- 3-5 ngày
- Mức độ hoạt động
- Ít trao đổi
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 52/100