-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathswagger.yaml
258 lines (257 loc) · 6.95 KB
/
swagger.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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
components:
schemas:
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
title: Detail
type: array
title: HTTPValidationError
type: object
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
title: Location
type: array
msg:
title: Message
type: string
type:
title: Error Type
type: string
required:
- loc
- msg
- type
title: ValidationError
type: object
info:
title: argo wrapper
version: 0.1.0
openapi: 3.1.0
paths:
/cancel/{workflow_name}:
post:
description: cancels a currently running workflow
operationId: cancel_workflow_cancel__workflow_name__post
parameters:
- in: path
name: workflow_name
required: true
schema:
title: Workflow Name
type: string
responses:
'200':
content:
application/json:
schema:
anyOf:
- type: string
- {}
title: Response Cancel Workflow Cancel Workflow Name Post
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Cancel Workflow
/logs/{workflow_name}:
get:
description: returns the list of workflows the user has ran
operationId: get_workflow_logs_logs__workflow_name__get
parameters:
- in: path
name: workflow_name
required: true
schema:
title: Workflow Name
type: string
- in: query
name: uid
required: true
schema:
title: Uid
type: string
responses:
'200':
content:
application/json:
schema:
anyOf:
- items:
type: object
type: array
- {}
title: Response Get Workflow Logs Logs Workflow Name Get
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get Workflow Logs
/retry/{workflow_name}:
post:
description: retries a currently failed workflow
operationId: retry_workflow_retry__workflow_name__post
parameters:
- in: path
name: workflow_name
required: true
schema:
title: Workflow Name
type: string
- in: query
name: uid
required: true
schema:
title: Uid
type: string
responses:
'200':
content:
application/json:
schema:
anyOf:
- type: string
- {}
title: Response Retry Workflow Retry Workflow Name Post
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Retry Workflow
/status/{workflow_name}:
get:
description: returns details of a workflow
operationId: get_workflow_details_status__workflow_name__get
parameters:
- in: path
name: workflow_name
required: true
schema:
title: Workflow Name
type: string
- in: query
name: uid
required: true
schema:
title: Uid
type: string
responses:
'200':
content:
application/json:
schema:
anyOf:
- type: object
- type: string
- {}
title: Response Get Workflow Details Status Workflow Name Get
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get Workflow Details
/submit:
post:
description: route to submit workflow
operationId: submit_workflow_submit_post
requestBody:
content:
application/json:
schema:
title: Request Body
type: object
required: true
responses:
'200':
content:
application/json:
schema:
anyOf:
- type: string
- {}
title: Response Submit Workflow Submit Post
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Submit Workflow
/test:
get:
description: route to test that the argo-workflow is correctly running
operationId: test_test_get
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
summary: Test
/workflows:
get:
description: returns the list of workflows the user has ran
operationId: get_workflows_workflows_get
parameters:
- in: query
name: team_projects
required: false
schema:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Team Projects
responses:
'200':
content:
application/json:
schema:
anyOf:
- items:
type: object
type: array
- {}
title: Response Get Workflows Workflows Get
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Get Workflows
/workflows/user-monthly:
get:
description: 'Query Argo service to see how many successful run user already
have in the current calendar month. Return workflow numbers and workflow cap'
operationId: get_user_monthly_workflow_workflows_user_monthly_get
responses:
'200':
content:
application/json:
schema:
title: Response Get User Monthly Workflow Workflows User Monthly Get
type: object
description: Successful Response
summary: Get User Monthly Workflow