microsoft / microsoft/api-guidelines
Add section on operation granularity
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
Based on a review comment from Krzysztof: "It's possible that I missed it, but I think we should have a section on granularity of service operations. From time to time we run into cases where a single user scenario corresponds to too many service calls. This means that client library has to to many calls to the service to actually do what the user cares about." This would make a good section in the considerations document.
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 by reading the linked review comment and locating the considerations document mentioned in the issue. Add a section explaining service-operation granularity and the impact of requiring too many service calls for one user scenario. Done means the guidance is included in that document and clearly addresses the described client-library concern.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100