This repository has been archived by the owner on Jan 11, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
/
swagger.yaml
796 lines (796 loc) · 18 KB
/
swagger.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
swagger: '2.0'
info:
description: 'This is for the zenodo API http://developers.zenodo.org/#rest-api'
version: 1.0.0
title: Zenodo
termsOfService: 'http://about.zenodo.org/terms/'
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
host: sandbox.zenodo.org
basePath: /api
schemes:
- https
paths:
/communities:
get:
summary: List of communities
description: ''
operationId: listCommunities
tags:
- preview
produces:
- application/json
responses:
'200':
description: OK
schema:
type: object
'405':
description: Method Not Allowed
/deposit/depositions:
get:
summary: List of deposits
description: ''
operationId: listDeposits
tags:
- deposits
produces:
- application/json
security:
- access_token: []
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/Deposit'
'405':
description: Method Not Allowed
post:
summary: Create a new deposit
description: ''
operationId: createDeposit
tags:
- deposits
consumes:
- application/json
produces:
- application/json
security:
- access_token: []
parameters:
- in: body
name: deposit
description: The deposit to create.
schema:
$ref: '#/definitions/Deposit'
responses:
'201':
description: OK
schema:
$ref: '#/definitions/Deposit'
'400':
description: Method Not Allowed
'500':
description: Internal Error
'/deposit/depositions/{depositId}':
get:
summary: Get deposit
description: Get a single deposit
parameters:
- in: path
name: depositId
type: integer
required: true
operationId: getDeposit
tags:
- deposits
produces:
- application/json
security:
- access_token: []
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Deposit'
'400':
description: Method Not Allowed
'500':
description: Internal Error
put:
summary: Put deposit
description: Update metadata for a single deposit
parameters:
- in: path
name: depositId
type: integer
required: true
- in: body
name: metadata
description: The deposit to update.
schema:
$ref: '#/definitions/NestedDepositMetadata'
operationId: putDeposit
tags:
- deposits
consumes:
- application/json
produces:
- application/json
security:
- access_token: []
responses:
'200':
description: OK
schema:
$ref: '#/definitions/Deposit'
'400':
description: Method Not Allowed
'500':
description: Internal Error
delete:
summary: Delete deposit
description: Delete a single deposit
parameters:
- in: path
name: depositId
type: integer
required: true
operationId: deleteDeposit
tags:
- deposits
security:
- access_token: []
responses:
'201':
description: OK
'204':
description: OK
'403':
description: Cannot delete already published deposit
'404':
description: Deposition does not exist
'/deposit/depositions/{depositId}/files':
get:
summary: List of files for deposit
description: ''
operationId: listFilesForDeposit
tags:
- files
parameters:
- in: path
name: depositId
type: integer
required: true
security:
- access_token: []
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/DepositionFile'
'400':
description: Method Not Allowed
'500':
description: Internal Error
produces:
- application/json
post:
summary: Create a new file
description: ''
operationId: createFile
tags:
- files
consumes:
- multipart/form-data
produces:
- application/json
security:
- access_token: []
parameters:
- in: path
name: depositId
type: integer
required: true
- in: formData
name: file
type: file
description: The file to upload
- in: formData
name: filename
type: string
description: Filename for file
responses:
'201':
description: OK
schema:
$ref: '#/definitions/DepositionFile'
'400':
description: Method Not Allowed
'500':
description: Internal Error
put:
summary: Sort the files for a deposit
description: ''
operationId: sortFiles
tags:
- files
consumes:
- application/json
produces:
- application/json
security:
- access_token: []
parameters:
- in: path
name: depositId
type: integer
required: true
- in: body
name: filelist
description: 'The order of files, use only the id portion of the array of files'
schema:
$ref: '#/definitions/DepositionFile'
responses:
'200':
description: OK
schema:
type: array
items:
$ref: '#/definitions/DepositionFile'
'400':
description: Method Not Allowed
'500':
description: Internal Error
'/deposit/depositions/{depositId}/files/{fileId}':
get:
summary: Retrieve a single deposition file.
description: ''
operationId: getFile
tags:
- files
produces:
- application/json
security:
- access_token: []
parameters:
- in: path
name: depositId
type: integer
required: true
- in: path
name: fileId
type: string
required: true
responses:
'200':
description: OK
schema:
$ref: '#/definitions/DepositionFile'
'400':
description: Method Not Allowed
'500':
description: Internal Error
put:
summary: >-
Update a deposition file resource. Currently the only use is renaming an
already uploaded file. If you want to replace the actual file, please
delete the file and upload a new file.
description: ''
operationId: updateFile
tags:
- files
produces:
- application/json
consumes:
- application/json
security:
- access_token: []
parameters:
- in: path
name: depositId
type: integer
required: true
- in: path
name: fileId
type: string
required: true
- in: body
name: data
schema:
$ref: '#/definitions/DepositionFile'
required: true
responses:
'200':
description: OK
schema:
$ref: '#/definitions/DepositionFile'
'400':
description: Method Not Allowed
'500':
description: Internal Error
delete:
summary: >-
Delete an existing deposition file resource. Note, only deposition files
for unpublished depositions may be deleted.
description: ''
operationId: deleteFile
tags:
- files
produces:
- application/json
consumes:
- application/json
security:
- access_token: []
parameters:
- in: path
name: depositId
type: integer
required: true
- in: path
name: fileId
type: string
required: true
responses:
'204':
description: OK
schema:
$ref: '#/definitions/DepositionFile'
'400':
description: Method Not Allowed
'500':
description: Internal Error
'/deposit/depositions/{depositId}/actions/publish':
post:
summary: >-
Publish a deposition. Note, once a deposition is published, you can no
longer delete it.
description: Untested swagger description
operationId: publishDeposit
tags:
- actions
produces:
- application/json
security:
- access_token: []
parameters:
- in: path
name: depositId
type: integer
required: true
responses:
'202':
description: OK
schema:
$ref: '#/definitions/Deposit'
'400':
description: Method Not Allowed
'500':
description: Internal Error
'/deposit/depositions/{depositId}/actions/edit':
post:
summary: Unlock already submitted deposition for editing.
description: Untested swagger description
operationId: editDeposit
tags:
- actions
produces:
- application/json
security:
- access_token: []
parameters:
- in: path
name: depositId
type: integer
required: true
responses:
'201':
description: OK
schema:
$ref: '#/definitions/Deposit'
'400':
description: Method Not Allowed
'409':
description: Conflict
'500':
description: Internal Error
'/deposit/depositions/{depositId}/actions/discard':
post:
summary: Discard changes in the current editing session.
description: Untested swagger description
operationId: discardDeposit
tags:
- actions
produces:
- application/json
security:
- access_token: []
parameters:
- in: path
name: depositId
type: integer
required: true
responses:
'201':
description: OK
schema:
$ref: '#/definitions/Deposit'
'400':
description: Method Not Allowed
'/deposit/depositions/{depositId}/actions/newversion':
post:
summary: Create a new version of a deposition.
description: Untested swagger description
operationId: newDepositVersion
tags:
- actions
produces:
- application/json
security:
- access_token: []
parameters:
- in: path
name: depositId
type: integer
required: true
responses:
'201':
description: OK
schema:
$ref: '#/definitions/Deposit'
'400':
description: Method Not Allowed
/funders:
get:
summary: List of funders
description: ''
operationId: listFunders
tags:
- preview
produces:
- application/json
responses:
'200':
description: OK
schema:
type: object
'405':
description: Method Not Allowed
/grants:
get:
summary: List of grants
description: ''
operationId: listGrants
tags:
- preview
produces:
- application/json
responses:
'200':
description: OK
schema:
type: object
'405':
description: Method Not Allowed
/licenses:
get:
summary: List of licenses
description: ''
operationId: listLicenses
tags:
- preview
produces:
- application/json
responses:
'200':
description: OK
schema:
type: object
'405':
description: Method Not Allowed
/records:
get:
summary: List of records
description: ''
operationId: listRecords
tags:
- preview
produces:
- application/json
responses:
'200':
description: OK
schema:
type: object
'405':
description: Method Not Allowed
securityDefinitions:
zenodo_auth:
type: oauth2
authorizationUrl: 'https://zenodo.org/oauth/authorize'
flow: implicit
scopes:
'deposit:write': >-
Grants write access to depositions, but does not allow publishing the
upload.
'deposit:actions': 'Grants access to publish, edit and discard edits for depositions.'
access_token:
type: apiKey
name: access_token
in: query
definitions:
Deposit:
type: object
properties:
conceptrecid:
type: integer
created:
type: string
format: date-time
files:
type: array
items:
$ref: '#/definitions/DepositionFile'
id:
type: integer
links:
type: object
additionalProperties:
type: string
metadata:
$ref: '#/definitions/DepositMetadata'
modified:
type: string
format: date-time
owner:
type: integer
record_id:
type: integer
state:
type: string
submitted:
type: boolean
title:
type: string
NestedDepositMetadata:
type: object
properties:
metadata:
$ref: '#/definitions/DepositMetadata'
DepositMetadata:
type: object
properties:
upload_type:
enum:
- publication
- poster
- presentation
- dataset
- image
- video
- software
publication_type:
enum:
- book
- section
- conferencepaper
- article
- patent
- preprint
- report
- softwaredocumentation
- thesis
- technicalnote
- workingpaper
- other
image_type:
enum:
- figure
- plot
- drawing
- diagram
- photo
- other
publication_date:
type: string
title:
type: string
creators:
type: array
items:
$ref: '#/definitions/Author'
description:
type: string
access_right:
enum:
- open
- embargoed
- restricted
- closed
license:
type: string
embargo_date:
type: string
format: date-time
access_conditions:
type: string
doi:
type: string
prereserve_doi:
type: object
keywords:
type: array
items:
type: string
notes:
type: string
related_identifiers:
type: array
items:
$ref: '#/definitions/RelatedIdentifier'
contributors:
type: array
items:
$ref: '#/definitions/Contributor'
references:
type: array
items:
type: string
communities:
type: array
items:
$ref: '#/definitions/Community'
grants:
type: array
items:
$ref: '#/definitions/Grant'
journal_title:
type: string
journal_volume:
type: string
journal_issue:
type: string
journal_pages:
type: string
conference_title:
type: string
conference_acronym:
type: string
conference_dates:
type: string
conference_place:
type: string
conference_url:
type: string
conference_session:
type: string
conference_session_part:
type: string
imprint_publisher:
type: string
imprint_isbn:
type: string
imprint_place:
type: string
partof_title:
type: string
partof_pages:
type: string
thesis_supervisors:
type: array
items:
$ref: '#/definitions/Author'
thesis_university:
type: string
subjects:
type: array
items:
$ref: '#/definitions/Subject'
version:
type: string
language:
type: string
required:
- upload_type
- publication_date
- title
- creators
- description
- access_right
Subject:
type: object
properties:
term:
type: string
identifier:
type: string
scheme:
type: string
Community:
type: object
properties:
id:
type: string
RelatedIdentifier:
type: object
properties:
identifier:
type: string
relation:
enum:
- isCitedBy
- cites
- isSupplementTo
- isSupplementedBy
- isNewVersionOf
- isPreviousVersionOf
- isPartOf
- hasPart
- compiles
- isCompiledBy
- isIdenticalTo
- isAlternateIdentifier
Grant:
type: object
properties:
identifier:
type: string
Contributor:
type: object
properties:
name:
type: string
type:
enum:
- ContactPerson
- DataCollector
- DataCurator
- DataManager
- Editor
- Researcher
- RightsHolder
- Sponsor
- Other
affiliation:
type: string
orcid:
type: string
gnd:
type: string
required:
- name
Author:
type: object
properties:
name:
type: string
affiliation:
type: string
orcid:
type: string
gnd:
type: string
required:
- name
DepositionFile:
type: object
properties:
id:
type: string
filename:
type: string
filesize:
type: integer
checksum:
type: string
required:
- id
- filename
- filesize
- checksum