Encourage callers to use $select and inform callers when there's default properties in the response

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

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
csharp, powershell
Lĩnh vực
api, cli

Hướng nghiên cứu

Không có tệp hoặc test nào được nêu tên. Hãy bắt đầu bằng cách lần theo cách Microsoft Graph PowerShell SDK xây dựng các request gửi đi và xử lý các header Prefer. Hoàn thành có nghĩa là các request bao gồm header opt-in ms-graph-dev-mode để các phản hồi Graph có thể cung cấp annotation về các mẹo đã mô tả; hãy xác nhận hành vi request liên quan bằng các test hiện có của repository.

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

Mô tả

AutoREST-dependency Needs: Team Discussion Request: Feature

Is your feature request related to a problem? Please describe.
Today API consumers regularly call API endpoints without using $select. This impacts performance of client apps (and impacts service COGS too). Additionally, APIs endpoints that return a default set of properties in a response don't inform callers that there are more properties available, and that they'll need to use $select - which is often a support call driver.

The API Gateway Service team (and API service teams) is trying to address these related issues by including a new "tips" instance annotation in the response to alert developers and encourage them to use $select, if $select is not being used. This annotation is also only added if the client application provides an opt-in "ms-graph-dev-mode" Prefer request header

Describe the solution you'd like
As one the the premium tools for API discoverability and testing, we'd like the Microsoft Graph PS app to send the prefer: ms-graph-dev-mode request header, so that the tips instance annotation shows up.

Describe alternatives you've considered
NA - although we vetted a range of ideas with Identity Developer Advisors.
Some of these ideas are captured in the link below.

Additional context
Feature spec

Ngôn ngữ chính
C#
Star
898
Fork
230
Merge trung bình
2 ngày 5 giờ
Pull request đã merge (30 ngày)
31

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.

Issue khác của microsoftgraph/msgraph-sdk-powershell

Tất cả issue của microsoftgraph/msgraph-sdk-powershell

Issue tương tự

Thêm issue về C#

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.