microsoft / microsoft/api-guidelines

[Azure REST Guidelines] Information on LRO Result

Open
#308 0 comments 1 reaction 1 assignee View on GitHub

@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:

  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?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.