microsoft / microsoft/api-guidelines
Clarify handling of repeatability of LRO POST action
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
Clarify the case of a long running post action with an existing operation id, where the request body is the same (retry scenario) in the guidelines. I read the spec, that always a 202 or 400 needs to be returned 400 when the payload is generally broken OR the operation id exists AND the request body is different. no conflict and no OK response for the retry. We mention the part of existing operationid, maybe we should just add some more text for non native speakers.
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 locating the long-running operation POST guidance in the API Guidelines and read the existing operation-id wording. Clarify the retry case where the request body is identical, distinguishing it from an invalid payload or a different body; done when the expected response behavior is unambiguous.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100