-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi-docs.yaml
188 lines (188 loc) · 4.39 KB
/
api-docs.yaml
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
openapi: 3.0.1
info:
title: OpenAPI definition
version: v0
servers:
- url: http://localhost:8080
description: Generated server url
paths:
/tasks:
get:
tags:
- task-controller
summary: Query tasks for user
operationId: taskList
parameters:
- name: assignee
in: query
description: Id of the assigned user
required: true
schema:
type: string
format: uuid
- name: name
in: query
description: Optional task name
required: false
schema:
type: string
- name: process_definition_name
in: query
description: Optional process definition name
required: false
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Task'
/started-process-instances:
get:
tags:
- process-instance-controller
summary: Query process instances by initiator and optionally by status
operationId: queryProcessInstanceByInitiatorAndStatus
parameters:
- name: initiator_id
in: query
description: Id of user initiated process
required: true
schema:
type: string
format: uuid
- name: status
in: query
description: Status of the process
required: false
schema:
type: string
enum:
- COMPLETED
- PENDING
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ProcessInstance'
/process-instances:
get:
tags:
- process-instance-controller
summary: Query process instances by process definition name
operationId: queryProcessInstanceByName
parameters:
- name: name
in: query
description: Name of the process definition
required: true
schema:
type: string
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ProcessInstance'
/comments:
get:
tags:
- comment-controller
summary: Query comments for process instance
operationId: queryCommentsByProcessInstanceId
parameters:
- name: process_instance_id
in: query
description: Id of the process instance
required: true
schema:
type: string
format: uuid
- name: author_id
in: query
description: Optional author id
required: false
schema:
type: string
format: uuid
responses:
"200":
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Comment'
components:
schemas:
Task:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
assignedAt:
type: string
format: date-time
completed:
type: boolean
completedAt:
type: string
format: date-time
processInstanceId:
type: string
format: uuid
processDefinitionName:
type: string
ProcessInstance:
type: object
properties:
id:
type: string
format: uuid
completed:
type: boolean
name:
type: string
initiator:
$ref: '#/components/schemas/User'
User:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
displayName:
type: string
createdAt:
type: string
format: date-time
Comment:
type: object
properties:
id:
type: string
format: uuid
text:
type: string
addedAt:
type: string
format: date-time
authorDisplayName:
type: string