Skip to content

Commit 278f3fa

Browse files
authored
pattern name
1 parent f337107 commit 278f3fa

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

graph/patterns/longRunningOperations.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Pattern Name
1+
# Long Running Operations
22

33
Microsoft Graph API Design Pattern
44

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.*
66

77
## Problem
88

@@ -79,37 +79,37 @@ heuristics:
7979

8080
## Issues and Considerations
8181

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
8383
at the same time.
8484

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
8686
SHOULD be able to determine the system state even if the operation tracking
8787
resource is no longer active. Clients MAY issue a GET on some resource to
8888
determine the state of a long running operation
8989

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"
9191
and for clients looking to actively monitor and act upon results.
9292

93-
4. Long running operations pattern may be supplemented by [Change Notification
93+
- Long running operations pattern may be supplemented by [Change Notification
9494
pattern](change-notification.md)
9595

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
9797
may mean rollback, or compensation, or completion, or partial completion,
9898
etc. Following a canceled operation the API should return a consistent state which allows
9999
continued service.
100100

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.
102102
Operations SHOULD transition to "tombstone" for an additional period of time
103103
prior to being purged from the system.
104104

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.
106106

107107

108108

109109
## Examples
110110

111111

112-
### Creating a new resource using RELO
112+
### Create a new resource using RELO
113113

114114
A client wants to provision a new database
115115

@@ -136,7 +136,7 @@ Content-Location: https://graph.microsoft.com/v1.0/databases/db1
136136
}
137137
```
138138

139-
### Creating a new resource using Stepwise Operation:
139+
### Create a new resource using Stepwise Operation:
140140

141141
```
142142
POST https://graph.microsoft.com/v1.0/databases/
@@ -156,7 +156,7 @@ Location: https://graph.microsoft.com/v1.0/operations/123
156156
157157
```
158158

159-
### Polling on a Stepwise Operation:
159+
### Poll on a Stepwise Operation:
160160

161161
```
162162

0 commit comments

Comments
 (0)