microsoft / microsoft/api-guidelines
[Azure REST Guidelines] Information on LRO Result
Open
@mikekistler is already working on this.
Since Jan 19, 2022.
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
At the moment, the docs for LROs say nothing on how to communicate the result of the LRO in the Status Monitor option.
From looking at AutoRest code, which seeks to implement these guidelines, it seems that the following holds:
- The original request that adds an
Operation-Locationheader with the Status Monitor URL should also add aLocationheader with the URL where the final result object should be retrieved. - Once the Status Monitor indicates successful completion, the URL specified in the
Locationheader should be queried for the result object.
2 questions:
- Can anyone confirm these are official (unwritten at this point) guidelines?
- Should there be any other SHOULDs here with regard to modeling the API endpoints of the status monitor and result endpoint, as well as their status codes?
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.