microsoftgraph / microsoftgraph/msgraph-sdk-powershell
Encourage callers to use $select and inform callers when there's default properties in the response
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 898
- Forks
- 230
- Avg merge
- 2d 5h
- Merged PRs (30d)
- 31
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No file or test is named. Start by tracing how the Microsoft Graph PowerShell SDK constructs outgoing requests and handles Prefer headers. Done means requests include the opt-in ms-graph-dev-mode header so Graph responses can provide the described tips annotation; confirm the relevant request behavior with the repository's existing tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp, powershell
- Domain
- api, cli
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100