msgraph-sdk-powershell icon indicating copy to clipboard operation
msgraph-sdk-powershell copied to clipboard

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

Open dkershaw10 opened this issue 2 years ago • 0 comments

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

dkershaw10 avatar Jul 20 '23 14:07 dkershaw10