api-guidelines icon indicating copy to clipboard operation
api-guidelines copied to clipboard

[Azure REST Guidelines] Information on LRO Result

Open ymarcov opened this issue 4 years ago • 0 comments

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:

  1. The original request that adds an Operation-Location header with the Status Monitor URL should also add a Location header with the URL where the final result object should be retrieved.
  2. Once the Status Monitor indicates successful completion, the URL specified in the Location header should be queried for the result object.

2 questions:

  1. Can anyone confirm these are official (unwritten at this point) guidelines?
  2. 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?

ymarcov avatar Dec 03 '21 08:12 ymarcov