microsoft / microsoft/OpenAPI.NET.OData
Add support for IsDelta in return types
Chưa có ai nhận issue này.
- 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ả
OASIS has added support for an IsDelta annotation that specifies that action or function parameters or return types may be represented as a delta (that is, they may contain deleted entities or nested changes). See https://github.com/oasis-tcs/odata-specs/blob/main/docs/odata-csdl-json/odata-csdl-json.md#annotation-coreisdelta) for a description of applying the annotation to a return type.
For example, the following "getChanges" function returns a collection of users, represented as a delta payload:
<Function Name="getChanges" IsBound="true">
<Parameter Name="bindingParameter" Type="microsoft.graph.savePoint" />
<ReturnType Type="Collection(microsoft.graph.user)">
<Annotation Term="Org.OData.Core.V1.IsDelta" Bool="true" />
</ReturnType>
</Function>
This Issue is to add support for this annotation to OpenAPI.NET.OData.
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
Issue không nêu tệp triển khai hoặc bài kiểm thử nào. Trước tiên, hãy xác định cách OpenAPI.NET.OData xử lý các chú thích OData và kiểu trả về, sau đó sử dụng hàm getChanges được nêu làm trường hợp đầu vào; công việc được xem là hoàn tất khi chú thích kiểu trả về IsDelta của hàm được biểu diễn chính xác trong tài liệu OpenAPI được tạo.
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, openapi
- 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
- 45/100