[Docs] Add documentation for LRO (Long Running Operations)#48180
[Docs] Add documentation for LRO (Long Running Operations)#48180JackTn wants to merge 1 commit intoAzure:mainfrom
Conversation
|
|
||
| This section captures two recurring issues in Java LRO discussions: | ||
|
|
||
| 1) Final LRO response shape and deserialization |
There was a problem hiding this comment.
add link to the teams case question?
is it in 4.1 and 4.2？
|
|
||
| ## 1. Definitions | ||
|
|
||
| ### 1.1 What an LRO is (service async) |
There was a problem hiding this comment.
this two definitions are a bit hard to understand for me. could you elaborate more on it?
I'm thinking if we could extract definition from official documents:
Below are LRO related documents.
Data plane:
Rest api guidelines: api-guidelines/azure/Guidelines.md at vNext · microsoft/api-guidelines
Service behavior (step by step flow): api-guidelines/azure/ConsiderationsForServiceDesign.md at vNext · microsoft/api-guidelines
TypeSpec Authoring: 6. Defining long-running resource operations | TypeSpec Azure Deep Dive: Long-running (Asynchronous) Operations | TypeSpec Azure
Management plane:
Rest api guidelines: resource-provider-contract/v1.0/async-api-reference.md at master · cloud-and-ai-microsoft/resource-provider-contract
TypeSpec Authoring: ARM Resource Operations | TypeSpec Azure
2 participants
This pull request adds a comprehensive documentation file summarizing the definition, usage, and common pitfalls of Long-Running Operations (LROs) in generated Azure Java SDKs. The document clarifies the distinction between service-side LROs and client-side async I/O, outlines how Java SDKs model LROs, and highlights real-world issues encountered by developers.
Documentation improvements:
doc/dev/java-sdk-lro.mdthat explains what LROs are, how Java SDKs implement them (including usage ofSyncPollerandPollerFlux), and the difference between service async and client async operations.Real-world troubleshooting and references: