You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: graph/patterns/longRunningOperations.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
-
# Pattern Name
1
+
# Long Running Operations
2
2
3
3
Microsoft Graph API Design Pattern
4
4
5
-
### *The Long Running Operations (LRO) Pattern provides the ability to model operations where processing a client request takes a long time, but the client isn't blocked and can do some other work until operation completion.*
5
+
### *The Long Running Operations (LRO) pattern provides the ability to model operations where processing a client request takes a long time, but the client isn't blocked and can do some other work until operation completion.*
6
6
7
7
## Problem
8
8
@@ -79,37 +79,37 @@ heuristics:
79
79
80
80
## Issues and Considerations
81
81
82
-
1. One or more clients MUST be able to monitor and operate on the same resource
82
+
- One or more clients MUST be able to monitor and operate on the same resource
83
83
at the same time.
84
84
85
-
2. The state of the system SHOULD be always discoverable and testable. Clients
85
+
- The state of the system SHOULD be always discoverable and testable. Clients
86
86
SHOULD be able to determine the system state even if the operation tracking
87
87
resource is no longer active. Clients MAY issue a GET on some resource to
88
88
determine the state of a long running operation
89
89
90
-
3. Long running operations SHOULD work for clients looking to "Fire and Forget"
90
+
- Long running operations SHOULD work for clients looking to "Fire and Forget"
91
91
and for clients looking to actively monitor and act upon results.
92
92
93
-
4. Long running operations pattern may be supplemented by [Change Notification
93
+
- Long running operations pattern may be supplemented by [Change Notification
94
94
pattern](change-notification.md)
95
95
96
-
5. Cancellation does not explicitly mean rollback. On a per API defined case it
96
+
- Cancellation does not explicitly mean rollback. On a per API defined case it
97
97
may mean rollback, or compensation, or completion, or partial completion,
98
98
etc. Following a canceled operation the API should return a consistent state which allows
99
99
continued service.
100
100
101
-
6. A recommended minimum retention time for a stepwise operation is 24 hours.
101
+
- A recommended minimum retention time for a stepwise operation is 24 hours.
102
102
Operations SHOULD transition to "tombstone" for an additional period of time
103
103
prior to being purged from the system.
104
104
105
-
7. Services that provides a new operation resource MUST support GET semantics on the operation.
105
+
- Services that provides a new operation resource MUST support GET semantics on the operation.
0 commit comments