Newer
Older
swagger: "2.0"
info:
description: "Capability service for the SSA Workspaces project"
version: "1.0.0"
title: "Capability Service"
contact:
email: "dms-ssa@nrao.edu"
host: "ws-dev.nrao.edu"
tags:
- name: "capabilities"
description: "Access capabilities and create requests"
- name: "requests"
description: "Access and submit capability requests"
- name: "workflows"
description: "Access and submit workflow requests"
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
/capabilities:
get:
tags:
- "capabilities"
summary: "View enabled capabilities"
description: ""
operationId: "view_enabled_capabilities"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/CapabilityList"
/capabilities/available_qa_staff:
get:
tags:
- "capabilities"
summary: "View available QA staff"
description: ""
operationId: "retrieve_available_qa_staff_in_group"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: query
name: "group"
description: ""
required: true
type: "string"
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/QaStaffList"
"404":
description: "no staff found"
/capabilities/analyst_email:
get:
tags:
- "capabilities"
summary: "Get workspaces analyst email address"
description: ""
operationId: "get_analyst_email"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/AnalystEmail"
"404":
description: "No email address found"
/capability/create:
post:
tags:
- "capabilities"
summary: "Create a new capability"
description: ""
operationId: "create_capability"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"400":
description: "Invalid name supplied"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Capability"
- $ref: "#/parameters/capability-name"
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
get:
tags:
- "capabilities"
summary: "View the named capability"
description: ""
operationId: "view_capability"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"400":
description: "Invalid name supplied"
"404":
description: "Capability not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Capability"
post:
tags:
- "capabilities"
summary: "Update an existing capability"
description: ""
operationId: "edit_capability"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Capability object that needs to be added to the system"
required: true
schema:
$ref: "#/definitions/Capability"
responses:
"400":
description: "Invalid name supplied"
"404":
description: "Capability not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Capability"
/capability/{name}/enable:
post:
tags:
- "capabilities"
summary: "Enable a capability"
operationId: "enable_capability"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- $ref: "#/parameters/capability-name"
responses:
"400":
description: "Invalid name supplied"
"404":
description: "Capability not found"
/capability/{name}/disable:
post:
tags:
- "capabilities"
summary: "Disable a capability"
operationId: "disable_capability"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- $ref: "#/parameters/capability-name"
responses:
"400":
description: "Invalid name supplied"
"404":
description: "Capability not found"
/capability/{name}/request:
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
- $ref: "#/parameters/capability-name"
get:
tags:
- "requests"
summary: "View the active capability requests"
description: ""
operationId: "view_active_capability_requests"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"400":
description: "Invalid capability name or request ID supplied"
"404":
description: "Capability request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/CapabilityRequest"
/capability/{name}/request/create:
parameters:
- $ref: "#/parameters/capability-name"
post:
tags:
- "requests"
summary: "Create a capability request"
description: ""
operationId: "create_capability_request"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"400":
description: "Invalid capability name or request ID supplied"
"404":
description: "Capability request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/CapabilityRequest"
/capability/request/{id}/followon/{followon_type}:
parameters:
- $ref: "#/parameters/capability-request-id"
- in: path
name: "followon_type"
description: "name of capability for follow-on"
required: true
type: "string"
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
post:
tags:
- "requests"
summary: "Create a follow-on capability request"
description: ""
operationId: "create_followon_capability_request"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"400":
description: "Invalid capability name or request ID supplied"
"404":
description: "Capability request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/CapabilityRequest"
/capability/{name}/created-requests:
parameters:
- $ref: "#/parameters/capability-name"
get:
tags:
- "requests"
summary: "View the created capability requests"
description: ""
operationId: "view_created_capability_requests"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"400":
description: "Invalid capability name or request ID supplied"
"404":
description: "Capability request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/CapabilityRequest"
/capability/request/{id}:
parameters:
- $ref: "#/parameters/capability-request-id"
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
get:
tags:
- "requests"
summary: "View the identified capability request"
description: ""
operationId: "view_capability_request"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"400":
description: "Invalid capability name or request ID supplied"
"404":
description: "Capability request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/CapabilityRequest"
post:
tags:
- "requests"
summary: "Update an existing capability request"
description: ""
operationId: "edit_capability_request"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "Capability object that needs to be added to the system"
required: true
schema:
$ref: "#/definitions/Capability"
responses:
"400":
description: "Invalid name supplied"
"404":
description: "Capability not found"
delete:
tags:
- "requests"
summary: "Delete a capability request"
description: ""
operationId: "delete_capability_request"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"400":
description: "Invalid name supplied"
"403":
description: "Permission denied; capability request already executed"
"404":
description: "Capability not found"
/capability/request/{id}/submit:
post:
tags:
- "requests"
summary: "Submit a capability request for execution"
description: ""
operationId: "submit_capability_request"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- $ref: "#/parameters/capability-request-id"
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
"200":
description: "successful operation"
schema:
$ref: "#/definitions/CapabilityExecution"
"400":
description: "Invalid name supplied"
"404":
description: "Capability not found"
/capability/request/{id}/create-and-submit:
post:
tags:
- "requests"
summary: "Create and submit a capability request for execution in one step"
description: "Mirror image of the workflow functionality of the same name."
operationId: "create_and_submit_capability_request"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- $ref: "#/parameters/capability-request-id"
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/CapabilityExecution"
"400":
description: "Invalid name supplied"
"404":
description: "Capability not found"
/capability/request/{id}/close:
post:
tags:
- "requests"
summary: "Close a failed capability request."
description: "Sets a capability request to sealed."
operationId: "close_capability_request"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- $ref: '#/parameters/capability-request-id'
responses:
"404":
description:
"Capability request not found"
"200":
description: "successful operation"
schema:
type: string
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
/capability/request/{id}/cancel:
post:
tags:
- "requests"
summary: "Cancel a capability request"
description: ""
operationId: "cancel_capability_request"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- $ref: "#/parameters/capability-request-id"
responses:
"400":
description: "Invalid name supplied"
"404":
description: "Capability not found"
/capability/request/{id}/version/latest:
parameters:
- $ref: "#/parameters/capability-request-id"
get:
tags:
- "requests"
summary: "View the latest version of this capability request"
description: ""
operationId: "view_latest_version"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"400":
description: "Invalid capability name or request ID supplied"
"404":
description: "Capability request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/CapabilityRequest"
/capability/request/{id}/version/create:
parameters:
- $ref: "#/parameters/capability-request-id"
post:
tags:
- "requests"
summary: "Create a new version of this capability request"
description: ""
operationId: "create_capability_version"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"400":
description: "Invalid capability name or request ID supplied"
"404":
description: "Capability request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/CapabilityRequest"
/capability/request/{id}/version/{version_id}/internal_notes:
parameters:
- $ref: "#/parameters/capability-request-id"
- $ref: "#/parameters/capability-version-id"
get:
tags:
- "requests"
summary: "Update the data analyst notes for this version"
description: ""
consumes:
- "application/json"
produces:
- "application/json"
responses:
"412":
description: "Invalid capability name or request ID supplied"
"404":
description: "Capability request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Notes"
post:
tags:
- "requests"
summary: "Update the data analyst notes for this version"
description: ""
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
consumes:
- "application/json"
produces:
- "application/json"
responses:
"412":
description: "Invalid capability name or request ID supplied"
"404":
description: "Capability request not found"
"200":
description: "successful operation"
schema:
type: string
/capability/request/{id}/version/{version_id}/workflow_metadata:
parameters:
- $ref: "#/parameters/capability-request-id"
- $ref: "#/parameters/capability-version-id"
get:
tags:
- "requests"
summary: "Get the workflow metadata for this version"
description: ""
operationId: "view_version_metadata"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"200":
description: "successful operation"
"404":
description: "Capability request not found"
post:
tags:
- "requests"
summary: "Edit the workflow metadata for this version"
description: ""
operationId: "edit_version_metadata"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"200":
description: "successful operation"
"404":
description: "Capability request not found"
/capability/request/{id}/version/srdp_compatible:
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
parameters:
- $ref: "#/parameters/capability-request-id"
- $ref: "#/parameters/capability-version-id"
post:
tags:
- "requests"
summary: "Set the SRDP compatibility flag"
description: ""
operationId: "change_srdp_compatibility_version_metadata"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"200":
description: "successful operation"
"404":
description: "Capability request not found"
"500":
description: "Unable to update"
"400":
description: "No metadata associated with this capability request version"
/capability/request/{id}/version/latest/files/{filename}:
parameters:
- $ref: "#/parameters/capability-request-id"
- $ref: "#/parameters/filename"
put:
tags:
- "requests"
summary: "Files in the latest version of this capability request"
description: ""
operationId: "update_file_for_latest"
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/CapabilityVersionFile"
"412":
description: "No versions exist for this capability request"
"404":
description: "Capability request not found"
/capability/request/execution/{request_id}:
parameters:
- $ref: "#/parameters/workflow-request-id"
get:
tags:
- "requests"
summary: "Get the execution for this workflow request ID"
description: ""
operationId: "get_execution_from_workflow_id"
responses:
412:
description: "No capability exists for this workflow ID"
200:
description: "successful operation"
schema:
$ref: "#/definitions/CapabilityExecution"
/capability/request/{id}/version/{version_id}/execution:
parameters:
- $ref: "#/parameters/capability-request-id"
- $ref: "#/parameters/capability-version-id"
get:
tags:
- "requests"
summary: "Get the execution under this request and version"
description: ""
operationId: "get_execution_by_version"
responses:
412:
description: "No capability exists for this workflow ID"
200:
description: "successful operation"
schema:
$ref: "#/definitions/CapabilityExecution"
/capability/request/execution/{request_id}/create_version:
parameters:
- $ref: "#/parameters/workflow-request-id"
post:
tags:
- "requests"
summary: "Create a new capability version based on the supplied workflow request ID"
description: ""
operationId: "create_version_from_previous_execution_script"
responses:
412:
description: "No capability exists for this workflow ID"
200:
description: "successful operation"
schema:
type: integer
/workflows:
get:
tags:
- "workflows"
summary: "View the list of workflows"
description: ""
operationId: "Workflows.list_workflows"
produces:
- "application/json"
responses:
"200":
description: "successful operation"
schema:
$ref: "#/definitions/WorkflowList"
/workflows/{name}:
get:
tags:
- "workflows"
summary: "View the named workflow"
description: ""
operationId: "Workflows.get_workflow"
parameters:
- $ref: '#/parameters/workflow-name'
consumes:
- "application/json"
produces:
- "application/json"
responses:
"404":
description:
"Workflow not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Workflow"
/workflows/{name}/requests/create:
post:
tags:
- "workflows"
summary: "Create a workflow request"
description: ""
operationId: "WorkflowRequestRestService.create_workflow_request"
parameters:
- $ref: '#/parameters/workflow-name'
- name: "body"
in: "body"
description: "Argument to the workflow"
schema:
type: "object"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"404":
description:
"Workflow not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/WorkflowRequest"
/workflows/{name}/requests/create-and-submit:
post:
tags:
- "workflows"
summary: "Create and submit a workflow request"
description: ""
operationId: "WorkflowRequestRestService.create_and_submit_workflow_request"
parameters:
- $ref: '#/parameters/workflow-name'
- name: "body"
in: "body"
description: "Argument to the workflow"
schema:
type: "object"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"404":
description:
"Workflow not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/WorkflowRequest"
/workflows/{name}/requests/{request_id}:
get:
tags:
- "workflows"
summary: "View the workflow request with this ID"
description: ""
operationId: "WorkflowRequestRestService.get_workflow_request"
parameters:
- $ref: '#/parameters/workflow-name'
- $ref: '#/parameters/workflow-request-id'
consumes:
- "application/json"
produces:
- "application/json"
responses:
"404":
description:
"Workflow request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/WorkflowRequest"
/workflows/{name}/requests/{request_id}/dir/{*paths}:
get:
summary: "View files in the working directory for the workflow request with this ID"
operationId: "WorkflowWorkingDirRestService.show_workdir_content"
- $ref: '#/parameters/workflow-name'
- $ref: '#/parameters/workflow-request-id'
- name: "*paths"
description: "path to the file under this workflow request"
required: true
type: "string"
consumes:
- "application/json"
produces:
- "application/json"
responses:
"404":
description:
"Workflow request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/WorkflowRequest"
/workflows/{name}/requests/{request_id}/weblog:
get:
tags:
- "workflows"
summary: "View the weblog under this workflow request"
description: ""
operationId: "WorkflowWorkingDirRestService.serve_weblog"
parameters:
- $ref: '#/parameters/workflow-name'
- $ref: '#/parameters/workflow-request-id'
consumes:
- "application/json"
produces:
- "application/json"
responses:
"404":
description:
"Workflow request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/WorkflowRequest"
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
/workflows/{name}/requests/{request_id}/qa_notes:
get:
tags:
- "workflows"
summary: "View the QA notes under this workflow request"
description: ""
operationId: "WorkflowWorkingDirRestService.get_qa_notes"
parameters:
- $ref: '#/parameters/workflow-name'
- $ref: '#/parameters/workflow-request-id'
consumes:
- "application/json"
produces:
- "application/json"
responses:
"404":
description:
"Workflow request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Notes"
post:
tags:
- "workflows"
summary: "Save the QA notes for this workflow request"
description: ""
operationId: "WorkflowWorkingDirRestService.save_qa_notes"
parameters:
- $ref: '#/parameters/workflow-name'
- $ref: '#/parameters/workflow-request-id'
consumes:
- "application/json"
produces:
- "application/json"
responses:
"404":
description:
"Workflow request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/Notes"
/workflows/{name}/requests/{request_id}/html:
get:
tags:
- "workflows"
summary: "Access a CARTA instance"
description: ""
operationId: "WorkflowWorkingDirRestService.serve_carta_wrapper"
parameters:
- $ref: '#/parameters/workflow-name'
- $ref: '#/parameters/workflow-request-id'
produces:
- "text/html"
responses:
200:
description: "successful operation"
/workflows/{name}/requests/{request_id}/htcondor_id:
get:
tags:
- "workflows"
summary: "Get the HTCondor ID for this request"
description: ""
operationId: "WorkflowRequestRestService.get_request_htcondor_id"
parameters:
- $ref: '#/parameters/workflow-name'
- $ref: '#/parameters/workflow-request-id'
consumes:
- "application/json"
produces:
- "application/json"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/HtCondorId"
/workflows/requests/stale/{days}:
get:
tags:
- "workflows"
summary: "Get a list of stale requests"
description: ""
operationId: "WorkflowRequestRestService.get_stale_requests"
parameters:
- in: path
name: days
type: integer
required: true
description: "days back to look"
consumes:
- "application/json"
produces:
- "application/json"
responses:
200:
description: "successful operation"
schema:
$ref: "#/definitions/StaleDirectories"
/workflows/{name}/requests/{request_id}/files:
get:
tags:
- "workflows"
summary: "See the files under this workflow request"
description: ""
operationId: "WorkflowFilesRestService.get_file"
parameters:
- $ref: '#/parameters/workflow-name'
- $ref: '#/parameters/workflow-request-id'
consumes:
- "application/octet-stream"
produces:
- "application/json"
responses:
"400":
description: "File already exists"
"404":
description:
"Workflow request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/WorkflowRequestFile"
/workflows/{name}/requests/{request_id}/files/{filename}:
put:
tags:
- "workflows"
summary: "Add a file to this workflow request"
description: ""
operationId: "WorkflowFilesRestService.add_file"
parameters:
- $ref: '#/parameters/workflow-name'
- $ref: '#/parameters/workflow-request-id'
- name: "filename"
in: "path"
description: "filename to add"
type: "string"
required: true
consumes:
- "application/octet-stream"
produces:
- "application/json"
responses:
"400":
description: "File already exists"
"404":
description:
"Workflow request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/WorkflowRequestFile"
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
/workflows/{name}/requests/{request_id}/submit:
post:
tags:
- "workflows"
summary: "Submit the workflow request for execution"
description: ""
operationId: "WorkflowRequestRestService.submit_workflow"
parameters:
- $ref: '#/parameters/workflow-name'
- $ref: '#/parameters/workflow-request-id'
consumes:
- "application/json"
produces:
- "application/json"
responses:
"404":
description:
"Workflow request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/WorkflowRequest"
/workflows/{name}/requests/{request_id}/ingest:
post:
tags:
- "workflows"
summary: "Ingest the result of this workflow"
description: ""
operationId: "WorkflowRequestRestService.ingest"
parameters:
- $ref: '#/parameters/workflow-name'
- $ref: '#/parameters/workflow-request-id'
consumes:
- "application/json"
produces:
- "application/json"
responses:
"404":
description:
"Workflow request not found"
"200":
description: "successful operation"
schema:
$ref: "#/definitions/WorkflowRequest"
post:
tags:
- "workflows"
summary: "Abort the execution of this running workflow"
operationId: "WorkflowRequestRestService.abort"
parameters:
- $ref: '#/parameters/workflow-request-id'
consumes:
- "application/json"
produces:
- "application/json"
responses:
"404":
description:
"Workflow request not found"
"200":
description: "successful operation"
schema: