microsoft / microsoft/api-guidelines
Document when to use an LRO vs. a VLRO in REST APIs
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
In the DeviceUpdate API, some operations use the x-ms-long-running-operation tag, where others are represented as a resource. This is according to the guidance found in the current API guidelines:
✅ DO implement an operation as an LRO if the 99th percentile response time is greater than 1s.
In rare instances where an operation may take a very long time to complete, e.g. longer than 15 minutes, it may be better to expose this as a first class resource of the API rather than as an operation on another resource.
https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#long-running-operations--jobs
It would be great to clarify guidance regarding when specifically to use operations on another resource vs. a standard LRO, and what this pattern looks like.
@JeffreyRichter, @mikekistler, @johanste, @krzysztofcwalina, @tg-msft, FYI
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.
Assessment
This issue has not been assessed yet.