microsoft / microsoft/api-guidelines
Revisit response time requirements for non-LRO operations
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
From this comment on #517
It would be nice to include a little more specificity into what a "significant amount of time" mean. Perhaps something like "the amount of time is call pattern specific and will vary from a service to another. However, the recommendation is for most services the P99 should complete within 10 seconds and P90 around 3 seconds." I see that we cover the numbers in the Guidelines.md file in the definition section but perhaps 1 second P99 is too stringent for most of the services?
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 Guidelines.md, especially the definition section that currently gives response-time numbers, then review the discussion linked from PR #517. The work is done when the non-LRO response-time recommendation clearly explains call-pattern variation and settles the appropriate P99 and P90 guidance.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100