-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenAPI-IWM-v2.yml
306 lines (294 loc) · 9.56 KB
/
openAPI-IWM-v2.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
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
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
---
openapi: 3.0.0
info:
title: HPC gateway app (IWM)
description: Access to IWM HPC through firecrest
version: 0.2.1
x-application-name: HPC gateway app (IWM)
x-api-version: 0.3.0
x-products:
- name: HPC gateway app (IWM)
product-id:
servers:
- url: https://staging.materials-marketplace.eu/message-broker
paths:
# Administrative path
/heartbeat:
get:
security:
- bearerAuth: []
description: Returns a heartbeat
operationId: heartbeat
responses:
'200':
description: Success
# need to create user at first
/api/v1/user/create:
put:
security:
- bearerAuth: []
description: Create user in DB and user repo in remote cluster
operationId: createOrUpdateCollection
responses:
'200':
description: Success
'404':
description: Not found
# Transformation app paths
/api/v1/job/create:
post:
security:
- bearerAuth: []
description: Initialize a Transformation (Job)
operationId: newTransformation
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TransformationConfig'
responses:
'200':
description: Success
content:
jobId:
schema:
type: string
example: 63907f1d36a9e8bd8e6b9c0c
'400':
description: Bad Request (unable to create job in remote cluster)
content:
jobId:
schema:
type: string
example: Wrong configuration input
/api/v1/job/launch/{jobid}:
patch:
security:
- bearerAuth: []
description: Launch a Transformation
operationId: updateTransformation
parameters:
- in: query
name: jobid
schema:
type: string
required: true
responses:
'200':
description: Success
content:
state:
schema:
type: string
example: running
'404':
description: Not found
content:
jobId:
schema:
type: string
example: Simulation Not found
'400':
description: Bad Request
content:
jobId:
schema:
type: string
example: Unexpected error
/api/v1/job/state/{jobid}:
get:
security:
- bearerAuth: []
description: Get the state of o Transformation
operationId: getTransformationState
parameters:
- in: query
name: jobid
schema:
type: string
required: true
responses:
'200':
description: Success
content:
state:
schema:
type: string
example: running
'404':
description: Not found
content:
jobId:
schema:
type: string
example: Simulation Not found
'400':
description: Bad Request
content:
jobId:
schema:
type: string
example: Unexpected error
/api/v1/job/cancel/{jobid}:
delete:
security:
- bearerAuth: []
description: Cancel the Transformation
operationId: deleteTransformation
parameters:
- in: path
name: jobid
schema:
type: string
required: true
responses:
'200':
description: Success
content:
state:
schema:
type: string
example: running
'404':
description: Not found
content:
jobId:
schema:
type: string
example: Simulation Not found
'400':
description: Bad Request
content:
jobId:
schema:
type: string
example: Unexpected error
# dataSource endpoints
/api/v1/file/download/{jobid}:
get:
security:
- bearerAuth: []
description: Get a file of the job.
operationId: getDataset
parameters:
- in: path
name: jobid
schema:
type: string
required: true
- in: query
name: filename
schema:
type: string
required: true
responses:
'200':
description: Success
content:
'*/*':
schema:
type: object
'404':
description: Not found
content:
resourceId:
schema:
type: string
example: Job not found
'400':
description: Bad Request
content:
resourceId:
schema:
type: string
example: Job is in progress
/api/v1/file/upload/{jobid}:
put:
security:
- bearerAuth: []
description: Upload file to job
operationId: createDataset
parameters:
- in: path
name: jobid
schema:
type: string
required: true
requestBody:
required: true
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/BodyFileCreateDataset'
responses:
'200':
description: Success
'404':
description: Not found
'400':
description: Bad Request
/api/v1/file/delete/{jobid}:
delete:
security:
- bearerAuth: []
description: Delete a file of the job.
operationId: deleteDataset
parameters:
- in: path
name: jobid
schema:
type: string
required: true
- in: query
name: filename
schema:
type: string
required: true
responses:
'200':
description: Success
'404':
description: Not found
'400':
description: Bad Request
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
schemas:
TransformationConfig:
title: TransformationConfig
required:
- Configuration
type: object
properties:
job_name:
title: image_name
type: string
ntasks_per_node:
title: ntasks_per_node
type: integer
partition:
title: partition
enum: [debug, normal]
type: string
image:
title: image
type: string
executable_cmd:
title: executable_cmd
type: string
description: Transformation data model
BodyFileCreateDataset:
title: BodyFileCreateDataset
required:
- file
type: object
properties:
file:
type: string
format: binary
description: File object by CreateDataset capability