Skip to content

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

Open
@dkershaw10

Description

@dkershaw10

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

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions