@@ -15,32 +15,31 @@ servers:
15
15
url : http://{host}:{port}/{version}
16
16
variables :
17
17
host :
18
- default : ' localhost'
18
+ default : " localhost"
19
19
port :
20
- default : ' 8080'
20
+ default : " 8080"
21
21
version :
22
- default : ' v0 '
22
+ default : " v0 "
23
23
enum :
24
- - ' v0 '
24
+ - " v0 "
25
25
- description : Production server
26
26
url : http://director:{port}/{version}
27
27
variables :
28
28
port :
29
- default : ' 8080'
29
+ default : " 8080"
30
30
version :
31
- default : ' v0 '
31
+ default : " v0 "
32
32
enum :
33
- - ' v0'
34
-
33
+ - " v0"
35
34
36
35
# tags are used for organizing operations
37
36
tags :
38
- - name : admins
39
- description : Secured Admin-only calls
40
- - name : developers
41
- description : Operations available to regular developers
42
- - name : users
43
- description : Operations available to regular users
37
+ - name : admins
38
+ description : Secured Admin-only calls
39
+ - name : developers
40
+ description : Operations available to regular developers
41
+ - name : users
42
+ description : Operations available to regular users
44
43
45
44
paths :
46
45
/ :
@@ -56,13 +55,13 @@ paths:
56
55
content :
57
56
application/json :
58
57
schema :
59
- $ref : ' #/components/schemas/HealthCheckEnveloped'
58
+ $ref : " #/components/schemas/HealthCheckEnveloped"
60
59
default :
61
60
description : Unexpected error
62
61
content :
63
62
application/json :
64
63
schema :
65
- $ref : ' #/components/schemas/ErrorEnveloped'
64
+ $ref : " #/components/schemas/ErrorEnveloped"
66
65
67
66
/services :
68
67
get :
@@ -72,26 +71,26 @@ paths:
72
71
description : Lists available services in the oSparc platform
73
72
operationId : services_get
74
73
parameters :
75
- - $ref : ' #/components/parameters/ServiceType'
74
+ - $ref : " #/components/parameters/ServiceType"
76
75
responses :
77
76
" 200 " :
78
77
description : Success, returns the list of available services
79
78
content :
80
79
application/json :
81
80
schema :
82
- $ref : ' #/components/schemas/ServicesEnveloped'
81
+ $ref : " #/components/schemas/ServicesEnveloped"
83
82
" 401 " :
84
83
description : Unauthorized access
85
84
content :
86
85
application/json :
87
86
schema :
88
- $ref : ' #/components/schemas/ErrorEnveloped'
87
+ $ref : " #/components/schemas/ErrorEnveloped"
89
88
default :
90
89
description : Unexpected error
91
90
content :
92
91
application/json :
93
92
schema :
94
- $ref : ' #/components/schemas/ErrorEnveloped'
93
+ $ref : " #/components/schemas/ErrorEnveloped"
95
94
96
95
/services/{service_key}/{service_version} :
97
96
get :
@@ -101,69 +100,69 @@ paths:
101
100
description : Returns details of the selected service if available in the oSparc platform
102
101
operationId : services_by_key_version_get
103
102
parameters :
104
- - $ref : ' #/components/parameters/ServiceKeyPath'
105
- - $ref : ' #/components/parameters/ServiceVersionPath'
103
+ - $ref : " #/components/parameters/ServiceKeyPath"
104
+ - $ref : " #/components/parameters/ServiceVersionPath"
106
105
responses :
107
106
" 200 " :
108
107
description : Success, returns the details of the service
109
108
content :
110
109
application/json :
111
110
schema :
112
- $ref : ' #/components/schemas/ServicesEnveloped'
111
+ $ref : " #/components/schemas/ServicesEnveloped"
113
112
" 401 " :
114
113
description : Unauthorized access
115
114
content :
116
115
application/json :
117
116
schema :
118
- $ref : ' #/components/schemas/ErrorEnveloped'
117
+ $ref : " #/components/schemas/ErrorEnveloped"
119
118
" 404 " :
120
119
description : Service not found
121
120
content :
122
121
application/json :
123
122
schema :
124
- $ref : ' #/components/schemas/ErrorEnveloped'
123
+ $ref : " #/components/schemas/ErrorEnveloped"
125
124
default :
126
125
description : Unexpected error
127
126
content :
128
127
application/json :
129
128
schema :
130
- $ref : ' #/components/schemas/ErrorEnveloped'
129
+ $ref : " #/components/schemas/ErrorEnveloped"
131
130
132
131
/service_extras/{service_key}/{service_version} :
133
132
get :
134
133
tags :
135
134
- users
136
135
summary : Returns the service's details which should be hidden from the user defined as extras.
137
136
description : Currently returns the node_requirements an array of resoruces needed for scheduling.
138
- operationId : services_extras_get
137
+ operationId : service_extras_by_key_version_get
139
138
parameters :
140
- - $ref : ' #/components/parameters/ServiceKeyPath'
141
- - $ref : ' #/components/parameters/ServiceVersionPath'
139
+ - $ref : " #/components/parameters/ServiceKeyPath"
140
+ - $ref : " #/components/parameters/ServiceVersionPath"
142
141
responses :
143
142
" 200 " :
144
143
description : Success, returns an object containing details hidden from the user
145
144
content :
146
145
application/json :
147
146
schema :
148
- $ref : ' #/components/schemas/ServiceExtrasEnveloped'
147
+ $ref : " #/components/schemas/ServiceExtrasEnveloped"
149
148
" 401 " :
150
149
description : Unauthorized access
151
150
content :
152
151
application/json :
153
152
schema :
154
- $ref : ' #/components/schemas/ErrorEnveloped'
153
+ $ref : " #/components/schemas/ErrorEnveloped"
155
154
" 404 " :
156
155
description : Service not found
157
156
content :
158
157
application/json :
159
158
schema :
160
- $ref : ' #/components/schemas/ErrorEnveloped'
159
+ $ref : " #/components/schemas/ErrorEnveloped"
161
160
default :
162
161
description : Unexpected error
163
162
content :
164
163
application/json :
165
164
schema :
166
- $ref : ' #/components/schemas/ErrorEnveloped'
165
+ $ref : " #/components/schemas/ErrorEnveloped"
167
166
168
167
/running_interactive_services :
169
168
get :
@@ -188,62 +187,62 @@ paths:
188
187
content :
189
188
application/json :
190
189
schema :
191
- $ref : ' #/components/schemas/RunningServicesEnveloped'
190
+ $ref : " #/components/schemas/RunningServicesEnveloped"
192
191
default :
193
192
description : Unexpected error
194
193
content :
195
194
application/json :
196
195
schema :
197
- $ref : ' #/components/schemas/ErrorEnveloped'
196
+ $ref : " #/components/schemas/ErrorEnveloped"
198
197
post :
199
198
tags :
200
199
- users
201
200
summary : Starts an interactive service in the oSparc platform
202
201
operationId : running_interactive_services_post
203
202
parameters :
204
- - $ref : ' #/components/parameters/UserId'
205
- - $ref : ' #/components/parameters/ProjectId'
206
- - $ref : ' #/components/parameters/ServiceKey'
207
- - $ref : ' #/components/parameters/ServiceVersion'
208
- - $ref : ' #/components/parameters/AssignmentUuid'
209
- - $ref : ' #/components/parameters/ServiceBasePath'
203
+ - $ref : " #/components/parameters/UserId"
204
+ - $ref : " #/components/parameters/ProjectId"
205
+ - $ref : " #/components/parameters/ServiceKey"
206
+ - $ref : " #/components/parameters/ServiceVersion"
207
+ - $ref : " #/components/parameters/AssignmentUuid"
208
+ - $ref : " #/components/parameters/ServiceBasePath"
210
209
responses :
211
210
" 201 " :
212
211
description : Succesfully created the service in the oSparc platform. Returns the location where the service runs.
213
212
content :
214
213
application/json :
215
214
schema :
216
- $ref : ' #/components/schemas/RunningServiceEnveloped'
215
+ $ref : " #/components/schemas/RunningServiceEnveloped"
217
216
" 400 " :
218
217
description : Malformed function call, missing field
219
218
content :
220
219
application/json :
221
220
schema :
222
- $ref : ' #/components/schemas/ErrorEnveloped'
221
+ $ref : " #/components/schemas/ErrorEnveloped"
223
222
" 401 " :
224
223
description : Unauthorized access
225
224
content :
226
225
application/json :
227
226
schema :
228
- $ref : ' #/components/schemas/ErrorEnveloped'
227
+ $ref : " #/components/schemas/ErrorEnveloped"
229
228
" 404 " :
230
229
description : Service not found
231
230
content :
232
231
application/json :
233
232
schema :
234
- $ref : ' #/components/schemas/ErrorEnveloped'
233
+ $ref : " #/components/schemas/ErrorEnveloped"
235
234
" 409 " :
236
235
description : A service with the same uuid already exists
237
236
content :
238
237
application/json :
239
238
schema :
240
- $ref : ' #/components/schemas/ErrorEnveloped'
239
+ $ref : " #/components/schemas/ErrorEnveloped"
241
240
default :
242
241
description : Unexpected error
243
242
content :
244
243
application/json :
245
244
schema :
246
- $ref : ' #/components/schemas/ErrorEnveloped'
245
+ $ref : " #/components/schemas/ErrorEnveloped"
247
246
248
247
/running_interactive_services/{service_uuid} :
249
248
get :
@@ -253,40 +252,40 @@ paths:
253
252
description : Succesfully returns if a service with the defined uuid is up and running
254
253
operationId : running_interactive_services_get
255
254
parameters :
256
- - $ref : ' #/components/parameters/ServiceUuid'
255
+ - $ref : " #/components/parameters/ServiceUuid"
257
256
responses :
258
257
" 200 " :
259
258
description : OK service exists and runs. Returns service location.
260
259
content :
261
260
application/json :
262
261
schema :
263
- $ref : ' #/components/schemas/RunningServiceEnveloped'
262
+ $ref : " #/components/schemas/RunningServiceEnveloped"
264
263
" 400 " :
265
264
description : Malformed function call, missing field
266
265
content :
267
266
application/json :
268
267
schema :
269
- $ref : ' #/components/schemas/ErrorEnveloped'
268
+ $ref : " #/components/schemas/ErrorEnveloped"
270
269
" 404 " :
271
270
description : Service not found
272
271
content :
273
272
application/json :
274
273
schema :
275
- $ref : ' #/components/schemas/ErrorEnveloped'
274
+ $ref : " #/components/schemas/ErrorEnveloped"
276
275
default :
277
276
description : Unexpected error
278
277
content :
279
278
application/json :
280
279
schema :
281
- $ref : ' #/components/schemas/ErrorEnveloped'
280
+ $ref : " #/components/schemas/ErrorEnveloped"
282
281
delete :
283
282
tags :
284
283
- users
285
284
summary : Stops and removes an interactive service from the oSparc platform
286
285
description : Stops and removes an interactive service from the oSparc platform
287
286
operationId : running_interactive_services_delete
288
287
parameters :
289
- - $ref : ' #/components/parameters/ServiceUuid'
288
+ - $ref : " #/components/parameters/ServiceUuid"
290
289
responses :
291
290
" 204 " :
292
291
description : Succesfully stopped and removed the service from the oSparc platform
@@ -295,19 +294,19 @@ paths:
295
294
content :
296
295
application/json :
297
296
schema :
298
- $ref : ' #/components/schemas/ErrorEnveloped'
297
+ $ref : " #/components/schemas/ErrorEnveloped"
299
298
" 404 " :
300
299
description : Service not found
301
300
content :
302
301
application/json :
303
302
schema :
304
- $ref : ' #/components/schemas/ErrorEnveloped'
303
+ $ref : " #/components/schemas/ErrorEnveloped"
305
304
default :
306
305
description : Unexpected error
307
306
content :
308
307
application/json :
309
308
schema :
310
- $ref : ' #/components/schemas/ErrorEnveloped'
309
+ $ref : " #/components/schemas/ErrorEnveloped"
311
310
312
311
components :
313
312
parameters :
@@ -385,8 +384,8 @@ components:
385
384
required : false
386
385
schema :
387
386
type : string
388
- example : ' /x/EycCXbU0H/'
389
- default : ' '
387
+ example : " /x/EycCXbU0H/"
388
+ default : " "
390
389
391
390
ServiceUuid :
392
391
in : path
@@ -428,19 +427,19 @@ components:
428
427
429
428
schemas :
430
429
ErrorEnveloped :
431
- $ref : ' ../common/schemas/error.yaml#/components/schemas/ErrorEnveloped'
430
+ $ref : " ../common/schemas/error.yaml#/components/schemas/ErrorEnveloped"
432
431
433
432
RunningServiceEnveloped :
434
- $ref : ' ../common/schemas/running_service.yaml#/components/schemas/RunningServiceEnveloped'
433
+ $ref : " ../common/schemas/running_service.yaml#/components/schemas/RunningServiceEnveloped"
435
434
436
435
RunningServicesEnveloped :
437
- $ref : ' ../common/schemas/running_service.yaml#/components/schemas/RunningServicesEnveloped'
436
+ $ref : " ../common/schemas/running_service.yaml#/components/schemas/RunningServicesEnveloped"
438
437
439
438
ServicesEnveloped :
440
- $ref : ' ../common/schemas/services.yaml#/components/schemas/ServicesEnveloped'
439
+ $ref : " ../common/schemas/services.yaml#/components/schemas/ServicesEnveloped"
441
440
442
441
ServiceExtrasEnveloped :
443
- $ref : ' ../common/schemas/services.yaml#/components/schemas/ServiceExtrasEnveloped'
442
+ $ref : " ../common/schemas/services.yaml#/components/schemas/ServiceExtrasEnveloped"
444
443
445
444
HealthCheckEnveloped :
446
- $ref : ' ../common/schemas/health_check.yaml#/components/schemas/HealthCheckEnveloped'
445
+ $ref : " ../common/schemas/health_check.yaml#/components/schemas/HealthCheckEnveloped"
0 commit comments