microsoft / microsoft/api-guidelines
Document how to implement "RELO" type LRO for action operations
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
The guidelines recommend adding ":" to the URL for a resource for an operation that performs an "action" that does not fit into the normal "CRUD" framework. But if that action operation is long-running, the standard pattern for RELO is unclear since it is not clear what the "URL for the resource" is.
We can solve this be requiring an action operation that wants to be a RELO LRO should return a Location header. This resolves the ambiguity.
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 reading the existing RELO and action-operation guidance referenced in the issue, then trace how the guidelines define the resource URL for long-running operations. Done means the documentation clearly specifies how an action-based RELO LRO identifies its resource, including whether a Location header is required.
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
- Mostly clear
- Newbie friendliness
- 35/100