microsoft / microsoft/OpenAPI.NET.OData
Optimization - reusable components for orderby/expand/select query parameters
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ả
Since #197 was implemented through #499, we have a big opportunity to make descriptions much smaller.
Effectively all operations now have the same definition for those query parameters when they support it
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
When the setting it on, we should do the same thing we do for count/top/skip/filter... and have instead
- $ref: '#/components/parameters/expand'
- $ref: '#/components/parameters/select'
- $ref: '#/components/parameters/orderby'
Which would save a ton of repetition throughout the final description.
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
Bắt đầu bằng cách xác định phần xử lý hiện có cho các tham số count/top/skip/filter có thể tái sử dụng và cài đặt điều khiển phần xử lý đó. Theo dõi cách orderby, select và expand hiện được phát ra, sau đó xác minh rằng việc bật cài đặt sẽ tạo ra các tham chiếu đến tham số component, đồng thời giữ nguyên hành vi hiện có khi cài đặt bị tắt.
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, backend-api-design
- Loại issue
- Tái cấu trúc
- Độ 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
- 35/100