-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
3519 lines (3519 loc) · 130 KB
/
openapi.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
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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
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
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
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
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
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
534
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
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
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
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
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
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
swagger: "2.0"
info:
title: Enduro API
version: ""
host: localhost:9000
consumes:
- application/json
produces:
- application/json
- application/xml
- application/gob
paths:
/batch:
get:
tags:
- batch
summary: status batch
description: Retrieve status of current batch operation.
operationId: batch#status
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/BatchStatusResponseBody'
required:
- running
schemes:
- http
post:
tags:
- batch
summary: submit batch
description: Submit a new batch
operationId: batch#submit
parameters:
- name: SubmitRequestBody
in: body
required: true
schema:
$ref: '#/definitions/BatchSubmitRequestBody'
required:
- path
responses:
"202":
description: Accepted response.
schema:
$ref: '#/definitions/BatchSubmitResponseBody'
required:
- workflow_id
- run_id
"400":
description: Bad Request response.
schema:
$ref: '#/definitions/BatchSubmitNotValidResponseBody'
"409":
description: Conflict response.
schema:
$ref: '#/definitions/BatchSubmitNotAvailableResponseBody'
schemes:
- http
/batch/hints:
get:
tags:
- batch
summary: hints batch
description: Retrieve form hints
operationId: batch#hints
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/BatchHintsResponseBody'
schemes:
- http
/package:
get:
tags:
- package
summary: list package
description: List all stored packages
operationId: package#list
parameters:
- name: name
in: query
required: false
type: string
- name: aip_id
in: query
required: false
type: string
format: uuid
- name: earliest_created_time
in: query
required: false
type: string
format: date-time
- name: latest_created_time
in: query
required: false
type: string
format: date-time
- name: location_id
in: query
required: false
type: string
format: uuid
- name: status
in: query
required: false
type: string
enum:
- new
- in progress
- done
- error
- unknown
- queued
- pending
- abandoned
- name: cursor
in: query
description: Pagination cursor
required: false
type: string
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/PackageListResponseBody'
required:
- items
schemes:
- http
/package/{id}:
get:
tags:
- package
summary: show package
description: Show package by ID
operationId: package#show
parameters:
- name: id
in: path
description: Identifier of package to show
required: true
type: integer
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/PackageShowResponseBody'
"404":
description: Not Found response.
schema:
$ref: '#/definitions/PackageShowNotFoundResponseBody'
required:
- message
- id
schemes:
- http
delete:
tags:
- package
summary: delete package
description: Delete package by ID
operationId: package#delete
parameters:
- name: id
in: path
description: Identifier of package to delete
required: true
type: integer
responses:
"204":
description: No Content response.
"404":
description: Not Found response.
schema:
$ref: '#/definitions/PackageDeleteNotFoundResponseBody'
required:
- message
- id
schemes:
- http
/package/{id}/cancel:
post:
tags:
- package
summary: cancel package
description: Cancel package processing by ID
operationId: package#cancel
parameters:
- name: id
in: path
description: Identifier of package to remove
required: true
type: integer
responses:
"200":
description: OK response.
"400":
description: Bad Request response.
schema:
$ref: '#/definitions/PackageCancelNotRunningResponseBody'
"404":
description: Not Found response.
schema:
$ref: '#/definitions/PackageCancelNotFoundResponseBody'
required:
- message
- id
schemes:
- http
/package/{id}/confirm:
post:
tags:
- package
summary: confirm package
description: Signal the package has been reviewed and accepted
operationId: package#confirm
parameters:
- name: id
in: path
description: Identifier of package to look up
required: true
type: integer
- name: ConfirmRequestBody
in: body
required: true
schema:
$ref: '#/definitions/PackageConfirmRequestBody'
required:
- location_id
responses:
"202":
description: Accepted response.
"400":
description: Bad Request response.
schema:
$ref: '#/definitions/PackageConfirmNotValidResponseBody'
"404":
description: Not Found response.
schema:
$ref: '#/definitions/PackageConfirmNotFoundResponseBody'
required:
- message
- id
"409":
description: Conflict response.
schema:
$ref: '#/definitions/PackageConfirmNotAvailableResponseBody'
schemes:
- http
/package/{id}/move:
get:
tags:
- package
summary: move_status package
description: Retrieve the status of a permanent storage location move of the package
operationId: package#move_status
parameters:
- name: id
in: path
description: Identifier of package to move
required: true
type: integer
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/PackageMoveStatusResponseBody'
required:
- done
"404":
description: Not Found response.
schema:
$ref: '#/definitions/PackageMoveStatusNotFoundResponseBody'
required:
- message
- id
"424":
description: Failed Dependency response.
schema:
$ref: '#/definitions/PackageMoveStatusFailedDependencyResponseBody'
schemes:
- http
post:
tags:
- package
summary: move package
description: Move a package to a permanent storage location
operationId: package#move
parameters:
- name: id
in: path
description: Identifier of package to move
required: true
type: integer
- name: MoveRequestBody
in: body
required: true
schema:
$ref: '#/definitions/PackageMoveRequestBody'
required:
- location_id
responses:
"202":
description: Accepted response.
"400":
description: Bad Request response.
schema:
$ref: '#/definitions/PackageMoveNotValidResponseBody'
"404":
description: Not Found response.
schema:
$ref: '#/definitions/PackageMoveNotFoundResponseBody'
required:
- message
- id
"409":
description: Conflict response.
schema:
$ref: '#/definitions/PackageMoveNotAvailableResponseBody'
schemes:
- http
/package/{id}/preservation-actions:
get:
tags:
- package
summary: preservation-actions package
description: List all preservation actions by ID
operationId: package#preservation-actions
parameters:
- name: id
in: path
description: Identifier of package to look up
required: true
type: integer
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/PackagePreservationActionsResponseBody'
"404":
description: Not Found response.
schema:
$ref: '#/definitions/PackagePreservationActionsNotFoundResponseBody'
required:
- message
- id
schemes:
- http
/package/{id}/reject:
post:
tags:
- package
summary: reject package
description: Signal the package has been reviewed and rejected
operationId: package#reject
parameters:
- name: id
in: path
description: Identifier of package to look up
required: true
type: integer
responses:
"202":
description: Accepted response.
"400":
description: Bad Request response.
schema:
$ref: '#/definitions/PackageRejectNotValidResponseBody'
"404":
description: Not Found response.
schema:
$ref: '#/definitions/PackageRejectNotFoundResponseBody'
required:
- message
- id
"409":
description: Conflict response.
schema:
$ref: '#/definitions/PackageRejectNotAvailableResponseBody'
schemes:
- http
/package/{id}/retry:
post:
tags:
- package
summary: retry package
description: Retry package processing by ID
operationId: package#retry
parameters:
- name: id
in: path
description: Identifier of package to retry
required: true
type: integer
responses:
"200":
description: OK response.
"400":
description: Bad Request response.
schema:
$ref: '#/definitions/PackageRetryNotRunningResponseBody'
"404":
description: Not Found response.
schema:
$ref: '#/definitions/PackageRetryNotFoundResponseBody'
required:
- message
- id
schemes:
- http
/package/bulk:
get:
tags:
- package
summary: bulk_status package
description: Retrieve status of current bulk operation.
operationId: package#bulk_status
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/PackageBulkStatusResponseBody'
required:
- running
schemes:
- http
post:
tags:
- package
summary: bulk package
description: Bulk operations (retry, cancel...).
operationId: package#bulk
parameters:
- name: BulkRequestBody
in: body
required: true
schema:
$ref: '#/definitions/PackageBulkRequestBody'
required:
- operation
- status
responses:
"202":
description: Accepted response.
schema:
$ref: '#/definitions/PackageBulkResponseBody'
required:
- workflow_id
- run_id
"400":
description: Bad Request response.
schema:
$ref: '#/definitions/PackageBulkNotValidResponseBody'
"409":
description: Conflict response.
schema:
$ref: '#/definitions/PackageBulkNotAvailableResponseBody'
schemes:
- http
/package/monitor:
get:
tags:
- package
summary: monitor package
operationId: package#monitor
responses:
"101":
description: Switching Protocols response.
schema:
$ref: '#/definitions/PackageMonitorResponseBody'
schemes:
- ws
/storage/location:
get:
tags:
- storage
summary: locations storage
description: List locations
operationId: storage#locations
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/StorageStoredLocationResponseCollection'
schemes:
- http
post:
tags:
- storage
summary: add_location storage
description: Add a storage location
operationId: storage#add_location
parameters:
- name: add_location_request_body
in: body
required: true
schema:
$ref: '#/definitions/StorageAddLocationRequestBody'
required:
- name
- source
- purpose
responses:
"201":
description: Created response.
schema:
$ref: '#/definitions/StorageAddLocationResponseBody'
required:
- uuid
"400":
description: Bad Request response.
schema:
$ref: '#/definitions/StorageAddLocationNotValidResponseBody'
schemes:
- http
/storage/location/{uuid}:
get:
tags:
- storage
summary: show-location storage
description: Show location by UUID
operationId: storage#show-location
parameters:
- name: uuid
in: path
required: true
type: string
format: uuid
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/StorageShowLocationResponseBody'
"404":
description: Not Found response.
schema:
$ref: '#/definitions/StorageShowLocationNotFoundResponseBody'
required:
- message
- uuid
schemes:
- http
/storage/package/{aip_id}:
get:
tags:
- storage
summary: show storage
description: Show package by AIPID
operationId: storage#show
parameters:
- name: aip_id
in: path
required: true
type: string
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/StorageShowResponseBody'
"404":
description: Not Found response.
schema:
$ref: '#/definitions/StorageShowNotFoundResponseBody'
required:
- message
- aip_id
schemes:
- http
/storage/package/{aip_id}/download:
get:
tags:
- storage
summary: download storage
description: Download package by AIPID
operationId: storage#download
parameters:
- name: aip_id
in: path
required: true
type: string
responses:
"200":
description: OK response.
schema:
type: string
format: byte
"404":
description: Not Found response.
schema:
$ref: '#/definitions/StorageDownloadNotFoundResponseBody'
required:
- message
- aip_id
schemes:
- http
/storage/package/{aip_id}/reject:
post:
tags:
- storage
summary: reject storage
description: Reject a package
operationId: storage#reject
parameters:
- name: aip_id
in: path
required: true
type: string
responses:
"202":
description: Accepted response.
"400":
description: Bad Request response.
schema:
$ref: '#/definitions/StorageRejectNotValidResponseBody'
"404":
description: Not Found response.
schema:
$ref: '#/definitions/StorageRejectNotFoundResponseBody'
required:
- message
- aip_id
"409":
description: Conflict response.
schema:
$ref: '#/definitions/StorageRejectNotAvailableResponseBody'
schemes:
- http
/storage/package/{aip_id}/store:
get:
tags:
- storage
summary: move_status storage
description: Retrieve the status of a permanent storage location move of the package
operationId: storage#move_status
parameters:
- name: aip_id
in: path
required: true
type: string
responses:
"200":
description: OK response.
schema:
$ref: '#/definitions/StorageMoveStatusResponseBody'
required:
- done
"404":
description: Not Found response.
schema:
$ref: '#/definitions/StorageMoveStatusNotFoundResponseBody'
required:
- message
- aip_id
"424":
description: Failed Dependency response.
schema:
$ref: '#/definitions/StorageMoveStatusFailedDependencyResponseBody'
schemes:
- http
post:
tags:
- storage
summary: move storage
description: Move a package to a permanent storage location
operationId: storage#move
parameters:
- name: aip_id
in: path
required: true
type: string
- name: MoveRequestBody
in: body
required: true
schema:
$ref: '#/definitions/StorageMoveRequestBody'
required:
- location_id
responses:
"202":
description: Accepted response.
"400":
description: Bad Request response.
schema:
$ref: '#/definitions/StorageMoveNotValidResponseBody'
"404":
description: Not Found response.
schema:
$ref: '#/definitions/StorageMoveNotFoundResponseBody'
required:
- message
- aip_id
"409":
description: Conflict response.
schema:
$ref: '#/definitions/StorageMoveNotAvailableResponseBody'
schemes:
- http
/storage/package/{aip_id}/submit:
post:
tags:
- storage
summary: submit storage
description: Start the submission of a package
operationId: storage#submit
parameters:
- name: aip_id
in: path
required: true
type: string
- name: SubmitRequestBody
in: body
required: true
schema:
$ref: '#/definitions/StorageSubmitRequestBody'
required:
- name
responses:
"202":
description: Accepted response.
schema:
$ref: '#/definitions/StorageSubmitResponseBody'
required:
- url
"400":
description: Bad Request response.
schema:
$ref: '#/definitions/StorageSubmitNotValidResponseBody'
"409":
description: Conflict response.
schema:
$ref: '#/definitions/StorageSubmitNotAvailableResponseBody'
schemes:
- http
/storage/package/{aip_id}/update:
post:
tags:
- storage
summary: update storage
description: Signal the storage service that an upload is complete
operationId: storage#update
parameters:
- name: aip_id
in: path
required: true
type: string
responses:
"202":
description: Accepted response.
"400":
description: Bad Request response.
schema:
$ref: '#/definitions/StorageUpdateNotValidResponseBody'
"409":
description: Conflict response.
schema:
$ref: '#/definitions/StorageUpdateNotAvailableResponseBody'
schemes:
- http
/swagger/swagger.json:
get:
tags:
- swagger
summary: Download internal/api/gen/http/openapi.json
description: JSON document containing the API swagger definition.
operationId: swagger#/swagger/swagger.json
responses:
"200":
description: File downloaded
schema:
type: file
schemes:
- http
definitions:
BatchHintsResponseBody:
title: BatchHintsResponseBody
type: object
properties:
completed_dirs:
type: array
items:
type: string
example: Voluptatum culpa eum mollitia enim dolor.
description: A list of known values of completedDir used by existing watchers.
example:
- Perspiciatis quia ab.
- Qui sunt nesciunt rerum et.
- Quo nihil dolor voluptates.
example:
completed_dirs:
- Dolor et reiciendis.
- Sunt totam ducimus.
- Animi sed qui eos voluptatum sed.
- Recusandae laudantium.
BatchStatusResponseBody:
title: BatchStatusResponseBody
type: object
properties:
run_id:
type: string
example: Voluptatem omnis non omnis.
running:
type: boolean
example: false
status:
type: string
example: Esse consequatur reiciendis ratione.
workflow_id:
type: string
example: Sit nisi quis atque expedita.
example:
run_id: Debitis consequatur inventore provident facilis ad.
running: true
status: Id praesentium sequi eveniet quia laudantium.
workflow_id: Hic quis delectus in.
required:
- running
BatchSubmitNotAvailableResponseBody:
title: 'Mediatype identifier: application/vnd.goa.error; view=default'
type: object
properties:
fault:
type: boolean
description: Is the error a server-side fault?
example: true
id:
type: string
description: ID is a unique identifier for this particular occurrence of the problem.
example: 123abc
message:
type: string
description: Message is a human-readable explanation specific to this occurrence of the problem.
example: parameter 'p' must be an integer
name:
type: string
description: Name is the name of this class of errors.
example: bad_request
temporary:
type: boolean
description: Is the error temporary?
example: false
timeout:
type: boolean
description: Is the error a timeout?
example: true
description: submit_not_available_response_body result type (default view)
example:
fault: true
id: 123abc
message: parameter 'p' must be an integer
name: bad_request
temporary: false
timeout: false
required:
- name
- id
- message
- temporary
- timeout
- fault
BatchSubmitNotValidResponseBody:
title: 'Mediatype identifier: application/vnd.goa.error; view=default'
type: object
properties:
fault:
type: boolean
description: Is the error a server-side fault?
example: true
id:
type: string
description: ID is a unique identifier for this particular occurrence of the problem.
example: 123abc
message:
type: string
description: Message is a human-readable explanation specific to this occurrence of the problem.
example: parameter 'p' must be an integer
name:
type: string
description: Name is the name of this class of errors.
example: bad_request
temporary:
type: boolean
description: Is the error temporary?
example: false
timeout:
type: boolean
description: Is the error a timeout?
example: true
description: submit_not_valid_response_body result type (default view)
example:
fault: false
id: 123abc
message: parameter 'p' must be an integer
name: bad_request
temporary: false
timeout: true
required:
- name
- id
- message
- temporary
- timeout
- fault
BatchSubmitRequestBody:
title: BatchSubmitRequestBody
type: object
properties:
completed_dir:
type: string
example: Dignissimos ut.
path:
type: string
example: Minima optio inventore sit neque.
retention_period:
type: string
example: Natus et ut deleniti cumque.
example:
completed_dir: Consequatur nihil et libero qui.
path: Architecto fugiat voluptatem.
retention_period: Numquam dolore libero quis qui.
required:
- path
BatchSubmitResponseBody:
title: BatchSubmitResponseBody
type: object
properties:
run_id:
type: string
example: Et deleniti ut.
workflow_id:
type: string
example: Ipsum et qui expedita.
example:
run_id: Modi omnis voluptatem.
workflow_id: Ut commodi nihil quod voluptatem.
required:
- workflow_id
- run_id
EnduroMonitorPingEventResponseBody:
title: 'Mediatype identifier: application/vnd.enduro.monitor-ping-event; view=default'
type: object
properties:
message:
type: string
example: Eum quae rerum unde.
description: EnduroMonitor-Ping-EventResponseBody result type (default view)
example:
message: Numquam soluta sint consequuntur dicta ut libero.
EnduroPackageCreatedEventResponseBody:
title: 'Mediatype identifier: application/vnd.enduro.package-created-event; view=default'
type: object
properties:
id:
type: integer
description: Identifier of package
example: 17708810917819370462
format: int64
item:
$ref: '#/definitions/EnduroStoredPackageResponseBody'
description: EnduroPackage-Created-EventResponseBody result type (default view)
example:
id: 15287223962745585853
item:
aip_id: 0C589E55-99C1-3ED8-809A-1463C91242B6
completed_at: "1987-10-08T08:22:22Z"
created_at: "1978-04-30T09:12:09Z"
id: 2295599406213606181
location_id: Rerum non qui et officia sint rerum.
name: Et omnis laudantium ut a sint quas.
run_id: 4CCDE767-7648-444F-D09F-4B4FFE4EB36B
started_at: "1976-09-24T19:50:46Z"
status: done
workflow_id: A129B534-C1FC-F09D-BF29-3DA5781E0ECB
required:
- id
- item
EnduroPackageDeletedEventResponseBody:
title: 'Mediatype identifier: application/vnd.enduro.package-deleted-event; view=default'
type: object
properties:
id:
type: integer
description: Identifier of package
example: 434853118052936476
format: int64
description: EnduroPackage-Deleted-EventResponseBody result type (default view)
example:
id: 17616113166657516382
required:
- id
EnduroPackageLocationUpdatedEventResponseBody:
title: 'Mediatype identifier: application/vnd.enduro.package-location-updated-event; view=default'
type: object
properties:
id:
type: integer
description: Identifier of package