microsoft / microsoft/api-guidelines
We should discuss a pattern for very long-running operations (VLROs)
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
I think we do NOT want to recommend the LRO pattern for very long-running operations (VLRO) because the client will effectively hang if polling to completion to make forward progress.
We need a time when an LRO transitions to a VLRO; for example, I think we'd all agree that 1 hour is a VLRO and that clients should not poll for 1 hour.
I suspect we'd handle this like Johan's Build progress example that he sometimes uses. In which case, we already have the pattern so e just need concrete guidance indicating when to switch from our LRO pattern to our existing GET pattern.
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 reviewing the existing LRO pattern, the existing GET pattern, and Johan's Build progress example referenced in the issue. Done means the guidelines contain concrete advice on when an operation becomes a VLRO and when clients should stop polling and use the GET pattern.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100