microsoft / microsoft/api-guidelines
Updated Azure Guidelines: Projections
Open
Nobody has claimed this yet.
Azure Guidelines
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
This came up during the first draft of collections guidance.
We should think about prescriptive guidance for projections (in List and maybe Get operations). Current Azure examples include:
$selectfor OData projections that narrow to a set of fields$expandfor OData projections fetch additional entities- an
includequery parameter to narrow conceptually (example)
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
Start with the first draft of collections guidance in pull request #243 and review the linked Azure examples for $select, $expand, and include. Compare how projections apply to List and Get operations, then document prescriptive guidance that resolves when each approach should be used.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure
- Domain
- api, backend-api-design, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 25/100