-
Notifications
You must be signed in to change notification settings - Fork 23
/
locks-openapi.yml
108 lines (102 loc) · 2.41 KB
/
locks-openapi.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
openapi: 3.0.0
info:
title: Distributed Lock API
description: Manage Distributed Locks
version: 1.0.0
paths:
/locks/acquire:
post:
summary: Acquire lock
description: Acquire a distributed lock
operationId: acquireLock
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/Lock"
required: true
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/Lock"
/locks/heartbeat:
post:
summary: heartbeat
description: update heartbeat for all locks that match the processId
operationId: heartbeat
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/HeartbeatRequest"
required: true
responses:
"200":
description: successful operation
content:
application/json:
schema:
$ref: "#/components/schemas/HeartbeatResponse"
/locks/release:
post:
summary: Release lock
description: Release a distributed lock
operationId: releaseLock
requestBody:
content:
application/json:
schema:
$ref: "#/components/schemas/ReleaseLockRequest"
required: true
responses:
"200":
description: successful operation
components:
schemas:
Lock:
type: object
properties:
resourceId:
type: string
processId:
type: string
executionId:
type: string
expiryInSeconds:
type: integer
format: int64
expiresAt:
type: integer
format: int64
readOnly: true
required:
- resourceId
- processId
- executionId
- expiryInSeconds
HeartbeatRequest:
type: object
properties:
processId:
type: string
required:
- processId
HeartbeatResponse:
type: object
properties:
locksAffected:
type: integer
format: int64
ReleaseLockRequest:
type: object
properties:
resourceId:
type: string
executionId:
type: string
required:
- resourceId
- executionId