microsoftgraph / microsoftgraph/msgraph-sdk-powershell

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

オープン
#2,175 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

AutoREST-dependency Needs: Team Discussion Request: Feature
主要言語
C#
スター
898
フォーク
230
平均マージ
2日 5時間
マージ済み PR(30日)
31

説明

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

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

ファイルもテストも指定されていません。まず、Microsoft Graph PowerShell SDK が送信リクエストをどのように構築し、Prefer ヘッダーをどのように処理するかを追跡してください。完了条件は、Graph のレスポンスが説明されたヒントのアノテーションを提供できるよう、リクエストに opt-in ヘッダー ms-graph-dev-mode が含まれることです。関連するリクエストの動作を、リポジトリに既存のテストで確認してください。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
csharp, powershell
領域
api, cli
issue の種類
機能追加
難易度
3/5
見積もり時間
1〜2日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
45/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。