-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.yml
1064 lines (1063 loc) · 30.5 KB
/
swagger.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
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
#editor.swagger.io
---
openapi: 3.0.0
info:
description: Merritt User Interface API
version: 1.0.0
title: Merritt User Interface API
tags:
- name: ui
description: Merritt UI endpoints. These should be used for UI usage, not as API endpoints.
- name: api
description: Merritt API endpoints. These will eventually be deployed to a new API that is separate from the UI.
- name: internal-use
description: Internal use within the UI app
- name: experimental
description: Experimental feature, subject to change. Feedback encouraged. These will eventually be promoted into the API.
components:
parameters:
arkParam:
in: path
name: ark
schema:
type: string
required: true
termsParam:
in: query
name: terms
schema:
type: string
required: true
description: url-encoded search term or local_id value
terms-localidParam:
in: query
name: terms
schema:
type: string
required: true
description: url-encoded local_id value
versionParam:
in: path
name: version
schema:
type: integer
required: true
fileParam:
in: path
name: file
schema:
type: string
description: url-encoded path to file within an object
required: true
groupPathParam:
in: path
name: group
schema:
type: string
required: true
description: LDAP Group or collection ark.
groupParam:
in: query
name: group
schema:
type: string
required: false
description: LDAP Group or collection ark.
contentParam:
in: query
name: content
schema:
type: string
enum:
- producer
- full
required: false
formatParam:
in: query
name: format
schema:
type: string
enum:
- zip
- tar
- targz
- zipunc
required: false
in_file:
in: query
name: file
schema:
type: string
required: true
description: file upload
in_creator:
in: query
name: creator
schema:
type: string
required: false
in_date:
in: query
name: date
schema:
type: string
required: false
in_digestType:
in: query
name: digestType
schema:
type: string
required: false
in_digestValue:
in: query
name: digestValue
schema:
type: string
required: false
in_localIdentifier:
in: query
name: localIdentifier
schema:
type: string
required: false
in_notification:
in: query
name: notification
schema:
type: string
required: false
in_notificationFormat:
in: query
name: notificationFormat
schema:
type: string
required: false
in_primaryIdentifier:
in: query
name: primaryIdentifier
schema:
type: string
required: false
in_profile:
in: query
name: profile
schema:
type: string
required: false
in_note:
in: query
name: note
schema:
type: string
required: false
in_responseForm:
in: query
name: responseForm
schema:
type: string
required: false
in_datacite:
in: query
name: DataCite.resourceType
schema:
type: string
required: false
in_dc_contributor:
in: query
name: DC.contributor
schema:
type: string
required: false
in_dc_coverage:
in: query
name: DC.coverage
schema:
type: string
required: false
in_dc_creator:
in: query
name: DC.creator
schema:
type: string
required: false
in_dc_date:
in: query
name: DC.date
schema:
type: string
required: false
in_dc_description:
in: query
name: DC.description
schema:
type: string
required: false
in_dc_format:
in: query
name: DC.format
schema:
type: string
required: false
in_dc_identifier:
in: query
name: 'DC.identifier'
schema:
type: string
required: false
in_dc_language:
in: query
name: DC.language
schema:
type: string
required: false
in_dc_publisher:
in: query
name: DC.publisher
schema:
type: string
required: false
in_dc_relation:
in: query
name: DC.relation
schema:
type: string
required: false
in_dc_rights:
in: query
name: DC.rights
schema:
type: string
required: false
in_dc_source:
in: query
name: DC.source
schema:
type: string
required: false
in_dc_subject:
in: query
name: DC.subject
schema:
type: string
required: false
in_dc_title:
in: query
name: DC.title
schema:
type: string
required: false
in_submitter:
in: query
name: submitter
schema:
type: string
required: false
in_title:
in: query
name: title
schema:
type: string
required: false
in_synchronousMode:
in: query
name: synchronousMode
schema:
type: string
required: false
in_retainTargetURL:
in: query
name: retainTargetURL
schema:
type: string
required: false
in_type:
in: query
name: type
schema:
type: string
required: false
responses:
presigned303:
description: presigned url returned as redirect
headers:
location:
schema:
type: string
description: contains presigned url, browser should redirect automatically
token:
description: return token to use in /api/presign-obj-by-token/ request
content:
application/json:
schema:
type: object
properties:
token:
type: string
description: token value to use for /api/presign-obj-by-token/ request
example: 1111-a1a1a1-2222
cloud-content-byte:
type: integer
description: uncompressed size of object to be retrieved
example: 12345
anticipated-availability-time:
type: string
description: Anticipated date/time that object assembly is expected to be complete. This should be used as a hint of when to call /api/presign-obj-by-token/.
example: '2009-06-15T13:45:30'
object:
description: display resource
content:
application/json:
schema:
type: object
properties:
ark:
type: string
example: ark:/99999/fk4349wz9t
version_number:
type: integer
example: 2
created:
type: string
example: "2019-10-24T16:16:22.000Z"
modified:
type: string
example: "2019-10-24T16:16:22.000Z"
erc_who:
type: string
example: "Author"
erc_what:
type: string
example: "Title"
erc_when:
type: string
example: "2019-10-29"
versions:
type: array
items:
type: object
properties:
version_number:
type: integer
example: 1
created:
type: string
example: "2019-10-29T09:18:11.000Z"
file_count:
type: integer
description: The complete number of files for a version will be computed here.
example: 17
files:
type: array
description: After 1000 files have been included, no more objects will be added to this structure.
items:
type: object
properties:
pathname:
type: string
example: "system/mrt-ingest.txt"
full_size:
type: integer
example: 1615
billable_size:
type: integer
example: 1615
mime_type:
type: string
example: "text/plain"
digest_value:
type: string
example: "017cfb96dacf9e157c9970269c99e4ecb0f7c7a75344475585c5cdfa4d56341b"
digest_type:
type: string
example: "sha-256"
localids:
type: array
items:
type: string
example: "my-localid"
total_files:
type: integer
description: A maximum of 1000 files will be included in the json object. The complete number (across all versions) will be computed here.
example: 17
included_files:
type: integer
description: A maximum of 1000 files will be included in the json object.
example: 17
paths:
/login:
get:
summary: Display login page
tags:
- ui
responses:
"200":
description: return login page
post:
summary: Send user login credentials
tags:
- ui
parameters:
- in: query
name: login
required: true
schema:
type: string
- in: query
name: password
required: true
schema:
type: string
responses:
"200":
description: display Merritt home with active user session or redirect to login page
/guest_login:
get:
summary: Redirect to guest login
tags:
- ui
responses:
"200":
description: display Merritt home with active guest user session
post:
summary: Send guest login credentials
tags:
- ui
responses:
"200":
description: display Merritt home with active guest user session
/logout:
get:
summary: User logout
tags:
- ui
responses:
"200":
description: display Merritt home with no active session
/m/{ark}:
get:
summary: Display collection or object page
tags:
- ui
parameters:
- $ref: '#/components/parameters/arkParam'
responses:
"200":
description: display resource
"401":
description: access not authorized
/m/{ark}/{version}:
get:
summary: Display object version page
tags:
- ui
parameters:
- $ref: '#/components/parameters/arkParam'
- $ref: '#/components/parameters/versionParam'
responses:
"200":
description: display resource
"401":
description: access not authorized
/api/object_info/{ark}:
get:
summary: Display json representation of an object
tags:
- experimental
parameters:
- $ref: '#/components/parameters/arkParam'
responses:
"200":
$ref: '#/components/responses/object'
"201":
description: no results
"401":
description: access not authorized
/home/choose_collection:
get:
summary: Select collection for user session
tags:
- ui
responses:
"200":
description: display resource
/user/update:
post:
summary: Update user profile
tags:
- ui
parameters:
- in: query
name: givenname
schema:
type: string
required: true
- in: query
name: sn
schema:
type: string
required: true
description: lastname
- in: query
name: userpassword
schema:
type: string
required: true
- in: query
name: repeatuserpassword
schema:
type: string
required: true
- in: query
name: mail
schema:
type: string
required: true
responses:
"200":
description: display updated profile
"401":
description: access not authorized
/s/{group}:
get:
summary: Display collection search results
tags:
- ui
parameters:
- $ref: '#/components/parameters/groupPathParam'
- $ref: '#/components/parameters/termsParam'
responses:
"200":
description: display resource
"401":
description: access not authorized
/api/{group}/local_id_search:
get:
summary: Return a json representation of an object within a collection identified by localid
tags:
- experimental
parameters:
- $ref: '#/components/parameters/groupPathParam'
- $ref: '#/components/parameters/terms-localidParam'
responses:
"200":
$ref: '#/components/responses/object'
"201":
description: no results
"401":
description: access not authorized
/version/index:
get:
summary: Access version page
tags:
- ui
responses:
"200":
description: display resource
"401":
description: access not authorized
/a/{ark}:
get:
summary: Dsiplay add object page
tags:
- ui
parameters:
- $ref: '#/components/parameters/arkParam'
responses:
"200":
description: display resource
"401":
description: access not authorized
/collection/object_count:
get:
summary: Get object count for collection
tags:
- ui
parameters:
- $ref: '#/components/parameters/groupParam'
responses:
"200":
description: return count as text
/collection/version_count:
get:
summary: Get version count for collection
tags:
- ui
parameters:
- $ref: '#/components/parameters/groupParam'
responses:
"200":
description: return count as text
/collection/file_count:
get:
summary: Get file count for collection
tags:
- ui
parameters:
- $ref: '#/components/parameters/groupParam'
responses:
"200":
description: return count as text
/collection/billable_size:
get:
summary: Get total billable byte size for collection
tags:
- ui
parameters:
- $ref: '#/components/parameters/groupParam'
responses:
"200":
description: return size as text
/d/{ark}/{version}/{file}:
get:
summary: Download file (stream bytes)
description: Deprecated. See /api/presign-file/
deprecated: true
tags:
- api
parameters:
- $ref: '#/components/parameters/arkParam'
- $ref: '#/components/parameters/versionParam'
- $ref: '#/components/parameters/fileParam'
responses:
"200":
description: display resource
"401":
description: access not authorized
/d/{ark}/{version}:
get:
summary: Download assembled object version (stream bytes)
deprecated: true
description: Deprecated. See /api/assemble-version/
tags:
- api
parameters:
- $ref: '#/components/parameters/arkParam'
- $ref: '#/components/parameters/versionParam'
responses:
"200":
description: display resource
"401":
description: access not authorized
/d/{ark}:
get:
summary: Download assembled object (stream bytes)
deprecated: true
description: Deprecated. See /api/assemble-object/
tags:
- api
parameters:
- $ref: '#/components/parameters/arkParam'
responses:
"200":
description: display resource
"401":
description: access not authorized
/u/{ark}/{version}:
get:
summary: Download assembled object version (stream bytes) including only producer files
deprecated: true
description: Deprecated. See /api/assemble-version/
tags:
- api
parameters:
- $ref: '#/components/parameters/arkParam'
- $ref: '#/components/parameters/versionParam'
responses:
"200":
description: display resource
"401":
description: access not authorized
/u/{ark}:
get:
summary: Download assembled object (stream bytes) including only producer files
deprecated: true
description: Deprecated. See /api/assemble-object/
tags:
- api
parameters:
- $ref: '#/components/parameters/arkParam'
responses:
"200":
description: display resource
"401":
description: access not authorized
/dm/{ark}:
get:
summary: Download object manifest (stream bytes)
tags:
- api
parameters:
- $ref: '#/components/parameters/arkParam'
responses:
"200":
description: display resource
"401":
description: access not authorized
/feeds/recent:
get:
summary: get recent items
tags:
- ui
parameters:
- in: query
name: collection
schema:
type: string
required: true
responses:
"200":
description: display resource
"401":
description: access not authorized
/object/recent.{feedtype}:
get:
summary: Generate atom feed - what other formats do we support?
tags:
- ui
parameters:
- in: path
name: feedtype
schema:
type: string
required: true
description: feed type should be atom
responses:
"200":
description: display resource
"401":
description: access not authorized
/api/presign-file/{ark}/{version}/{file}:
get:
summary: Retrieve file by presigned url
tags:
- api
parameters:
- $ref: '#/components/parameters/arkParam'
- $ref: '#/components/parameters/versionParam'
- $ref: '#/components/parameters/fileParam'
- in: query
name: no_redirect
schema:
type: boolean
required: false
description: if set, presigned url will be sent in payload
- in: query
name: contentDisposition
schema:
type: string
enum:
- attachment
required: false
description: if set, the presigned Url will download as an attachment (rather than displaying in a browser) regardless of the contentType for the file
responses:
"200":
description: presigned url in payload
content:
application/json:
schema:
type: object
properties:
url:
type: string
example: https://some.really.long.presigned.url/file.txt
"303":
$ref: '#/components/responses/presigned303'
"401":
description: access not authorized
"403":
description: object exists, content cannot be processed
"404":
description: object does not exist
"500":
description: processing error
/api/get-storage-key-file/{ark}/{version}/{file}:
get:
summary: Create key to send to storage service
deprecated: true
description: Deprecated? This is called in unit tests, but is probably not called internally
tags:
- internal-use
parameters:
- $ref: '#/components/parameters/arkParam'
- $ref: '#/components/parameters/versionParam'
- $ref: '#/components/parameters/fileParam'
responses:
"200":
description: return key for accessing content in storage
content:
application/json:
schema:
type: object
properties:
node_id:
type: integer
description: storage node identifer
example: 4444
key:
type: string
description: key for retrieving content
example: producer/README.txt
/api/assemble-version/{ark}/{version}:
get:
summary: Start async assembly of object version
tags:
- api
parameters:
- $ref: '#/components/parameters/arkParam'
- $ref: '#/components/parameters/versionParam'
- $ref: '#/components/parameters/contentParam'
- $ref: '#/components/parameters/formatParam'
responses:
"200":
$ref: '#/components/responses/token'
"403":
description: object exists, content cannot be processed
"404":
description: object does not exist
"500":
description: processing error
/api/assemble-obj/{ark}:
get:
summary: Start async assembly of object
tags:
- api
parameters:
- $ref: '#/components/parameters/arkParam'
- $ref: '#/components/parameters/contentParam'
- $ref: '#/components/parameters/formatParam'
responses:
"200":
$ref: '#/components/responses/token'
"403":
description: object exists, content cannot be processed
"404":
description: object does not exist
"500":
description: processing error
/api/presign-obj-by-token/{token}:
get:
summary: Retrive assembled object/version by presigned url
tags:
- api
parameters:
- in: path
name: token
schema:
type: string
required: true
- in: query
name: no_redirect
schema:
type: boolean
required: false
description: if set, presigned url will be sent in payload
- in: query
name: filename
schema:
type: string
required: false
description: name to assign to download file, defaults to object.zip
responses:
"303":
description: presigned url returned as redirect
headers:
location:
schema:
type: string
description: contains presigned url, browser should redirect automatically
"200":
description: presigned url available in payload (when no_redirect is specified)
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: Payload contains token info
url:
type: string
description: presigned url to object/version container file
example: https://some.really.long.presigned.url/container.zip
cloud-content-byte:
type: integer
description: uncompressed size of object to be retrieved
example: 12345
token:
type: string
description: token value to use for /api/presign-obj-by-token/ request
example: 1111-a1a1a1-2222
"202":
description: Object assembly is not yet ready. Pause and repeat request at anticipated-availability-time.
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: object is not ready
anticipated-availability-time:
type: string
description: Anticipated date/time that object assembly is expected to be complete. This should be used as a hint of when to call /api/presign-obj-by-token/.
example: '2009-06-15T13:45:30'
cloud-content-byte:
type: integer
description: uncompressed size of object to be retrieved
example: 12345
token:
type: string
description: token value to use for /api/presign-obj-by-token/ request
example: 1111-a1a1a1-2222
"410":
description: Object is no longer available. Restart assembly request.
content:
application/json:
schema:
type: object
properties:
message:
type: string
example: signed url has expired
expiration-time:
type: string
example: '2009-06-15T13:45:30'
cloud-content-byte:
type: integer
description: uncompressed size of object to be retrieved
example: 12345
token:
type: string
description: token value to use for /api/presign-obj-by-token/ request
example: 1111-a1a1a1-2222
"404":
description: object does not exist
"500":
description: processing error
/object/upload:
post:
summary: Start object ingest (tbd differentiate ingest vs upload)
tags:
- ui
- api
parameters:
- $ref: '#/components/parameters/in_file'
- $ref: '#/components/parameters/in_creator'
- $ref: '#/components/parameters/in_date'
- $ref: '#/components/parameters/in_localIdentifier'
- $ref: '#/components/parameters/in_primaryIdentifier'
- $ref: '#/components/parameters/in_profile'
- $ref: '#/components/parameters/in_responseForm'
- $ref: '#/components/parameters/in_title'
- $ref: '#/components/parameters/in_type'
responses:
"200":
description: TBD
/object/ingest:
post:
summary: Start object ingest (tbd differentiate ingest vs upload)
tags:
- ui
- api
parameters:
- $ref: '#/components/parameters/in_file'
- $ref: '#/components/parameters/in_creator'
- $ref: '#/components/parameters/in_date'
- $ref: '#/components/parameters/in_digestType'
- $ref: '#/components/parameters/in_digestValue'
- $ref: '#/components/parameters/in_localIdentifier'
- $ref: '#/components/parameters/in_notification'
- $ref: '#/components/parameters/in_notificationFormat'
- $ref: '#/components/parameters/in_primaryIdentifier'
- $ref: '#/components/parameters/in_profile'
- $ref: '#/components/parameters/in_note'
- $ref: '#/components/parameters/in_responseForm'
- $ref: '#/components/parameters/in_datacite'
- $ref: '#/components/parameters/in_dc_contributor'
- $ref: '#/components/parameters/in_dc_coverage'
- $ref: '#/components/parameters/in_dc_creator'
- $ref: '#/components/parameters/in_dc_date'
- $ref: '#/components/parameters/in_dc_description'
- $ref: '#/components/parameters/in_dc_format'
- $ref: '#/components/parameters/in_dc_identifier'
- $ref: '#/components/parameters/in_dc_language'
- $ref: '#/components/parameters/in_dc_publisher'
- $ref: '#/components/parameters/in_dc_relation'
- $ref: '#/components/parameters/in_dc_rights'
- $ref: '#/components/parameters/in_dc_source'
- $ref: '#/components/parameters/in_dc_subject'
- $ref: '#/components/parameters/in_dc_title'
- $ref: '#/components/parameters/in_submitter'
- $ref: '#/components/parameters/in_title'
- $ref: '#/components/parameters/in_synchronousMode'
- $ref: '#/components/parameters/in_retainTargetURL'
- $ref: '#/components/parameters/in_type'
responses:
"200":
description: TBD
/object/update:
post:
summary: Start new version ingest for an object