-
Notifications
You must be signed in to change notification settings - Fork 2
/
swagger.json
830 lines (800 loc) · 38.9 KB
/
swagger.json
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
{
"openapi": "3.0.0",
"info": {
"title": "gypsum REST API",
"description": "Upload files to the gypsum file store.",
"version": "1.0.0"
},
"servers": [
{
"url": "https://gypsum.artifactdb.com",
"description": "Production instance of the API"
},
{
"url": "https://gypsum-test.artifactdb.com",
"description": "Test instance of the API"
}
],
"paths": {
"/create/{project}": {
"post": {
"summary": "Create a new project. This requires administrator privileges.",
"parameters": [
{ "$ref": "#/components/parameters/project" }
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"description": "Project creation parameters.",
"properties": {
"permissions": { "$ref": "#/components/schemas/permissions" },
"quota": { "$ref": "#/components/schemas/quota" }
}
}
}
}
},
"security": [ { "admin": [] } ],
"responses": {
"200": { "description": "Successful project creation." },
"400": {
"description": "Invalid project name, or the project already exists.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/error" }
}
}
},
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": ["Creation"]
}
},
"/remove/{project}": {
"delete": {
"summary": "Remove a project. This requires administrator privileges.",
"parameters": [
{ "$ref": "#/components/parameters/project" }
],
"security": [ { "admin": [] } ],
"responses": {
"200": { "description": "Successful project removal. Note that this is returned even if `project` did not exist." },
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": ["Deletion"]
}
},
"/remove/{project}/{asset}": {
"delete": {
"summary": "Remove an asset from a project. This requires administrator privileges.",
"parameters": [
{ "$ref": "#/components/parameters/project" },
{ "$ref": "#/components/parameters/asset" }
],
"security": [ { "admin": [] } ],
"responses": {
"200": { "description": "Successful asset removal. Note that this is returned even if `project` or `asset` did not exist." },
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": ["Deletion"]
}
},
"/remove/{project}/{asset}/{version}": {
"delete": {
"summary": "Remove a version of an asset from a project. This requires administrator privileges.",
"parameters": [
{ "$ref": "#/components/parameters/project" },
{ "$ref": "#/components/parameters/asset" },
{ "$ref": "#/components/parameters/version" }
],
"security": [ { "admin": [] } ],
"responses": {
"200": { "description": "Successful version removal. Note that this is returned even if `project`, `asset` or `version` did not exist." },
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": ["Deletion"]
}
},
"/upload/start/{project}/{asset}/{version}": {
"post": {
"summary": "Start an upload of a new asset or a new version of an existing asset for a project. This requires uploader privileges.",
"parameters": [
{ "$ref": "#/components/parameters/project" },
{ "$ref": "#/components/parameters/asset" },
{ "$ref": "#/components/parameters/version" }
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [ "files" ],
"properties": {
"files": {
"description": "Files to be uploaded.",
"type": "array",
"items": {
"type": "object",
"required": [ "path", "type" ],
"properties": {
"path": {
"type": "string",
"description": "Path to the file. This is interpreted relative to the version subdirectory."
},
"type": {
"type": "string",
"enum": [ "simple", "dedup", "link" ],
"description": "Type of upload. For `simple`, files are directly uploaded to the destination bucket. For `dedup`, the API will attempt to find a matching file (based on the MD5 checksums and size) in the previous version, and create a link to that version instead of uploading a copy; if no copy can be found, it falls back to `simple`. For `link`, the user is expected to specify the link destination for `path`, and no file is actually uploaded."
},
"md5sum": {
"type": "string",
"description": "MD5 checksum for the file, hex-encoded. This only needs to be supplied if `type` is not `link`."
},
"size": {
"type": "integer",
"description": "Type of the file, in bytes. This only needs to be supplied if `type` is not `link`.",
"minimum": 0
},
"link": {
"type": "object",
"description": "Link destination for the file, if `type` is `link`.",
"required": [ "project", "asset", "version", "path" ],
"properties": {
"project": {
"type": "string",
"description": "Project of the link destination."
},
"asset": {
"type": "string",
"description": "Asset of the link destination."
},
"version": {
"type": "string",
"description": "Version of the link destination."
},
"path": {
"type": "string",
"description": "Relative path of the link destination."
}
}
}
}
}
}
}
}
}
}
},
"security": [ { "uploader": [] } ],
"responses": {
"200": {
"description": "Successful initialization of an upload.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [ "file_urls", "complete_url", "abort_url", "session_token" ],
"properties": {
"file_urls": {
"description": "URLs for uploading non-link files from the request's `files`.",
"type": "array",
"items": {
"type": "object",
"required": [ "method", "path", "url" ],
"properties": {
"method": {
"type": "string",
"description": "Upload method. If `presigned`, a `POST` request to `url` will obtain a presigned S3 URL for direct upload, see the `/upload/presigned-file` endpoint for details. If `multipart`, a `POST` request to `url` will start a multi-part upload.",
"enum": ["presigned", "multipart"]
},
"path": {
"type": "string",
"description": "Relative path of the file to be uploaded. This is taken from the `files.path` in the initial request."
},
"url": {
"type": "string",
"description": "URL to use to start the upload. The exact upload method depends on `method`."
}
}
}
},
"complete_url": {
"type": "string",
"description": "URL to indicating that the upload of all individual files is complete, see the `/upload/complete` endpoint for details."
},
"abort_url": {
"type": "string",
"description": "URL to abort the upload, see the `/upload/abort` endpoint for details."
},
"session_token": {
"type": "string",
"description": "Token to authenticate subsequent requests for this upload session."
}
}
}
}
}
},
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": ["Upload"]
}
},
"/upload/presigned-file/{slug}": {
"post": {
"summary": "Request a presigned URL to upload a single file. This requires a token for initialized upload session.",
"parameters": [
{
"in": "path",
"name": "slug",
"description": "Base64-encoded JSON string containing upload details for a particular file. This is typically generated by the `/upload/start` endpoint.",
"schema": {
"type": "string"
},
"required": true
}
],
"security": [ { "session": [] } ],
"responses": {
"200": {
"description": "Successful request for a presigned URL.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [ "url", "md5sum_base64" ],
"properties": {
"url": {
"type": "string",
"description": "Presigned URL that can be directly used for a file upload via `PUT`."
},
"md5sum_base64": {
"type": "string",
"description": "Base64-encoded MD5 checksum, to be attached as the `Content-MD5` header in the request to `url`."
}
}
}
}
}
},
"400": {
"description": "Incorrectly formatted request, or the specified version of the project asset already exists.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/error" }
}
}
},
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": ["Upload"]
}
},
"/upload/complete/{project}/{asset}/{version}": {
"post": {
"summary": "Complete an upload. This requires a token for an initialized upload session.",
"parameters": [
{ "$ref": "#/components/parameters/project" },
{ "$ref": "#/components/parameters/asset" },
{ "$ref": "#/components/parameters/version" }
],
"security": [ { "session": [] } ],
"responses": {
"200": { "description": "Successful completion." },
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": ["Upload"]
}
},
"/upload/abort/{project}/{asset}/{version}": {
"post": {
"summary": "Abort an upload. This requires a token for an initialized upload session.",
"parameters": [
{ "$ref": "#/components/parameters/project" },
{ "$ref": "#/components/parameters/asset" },
{ "$ref": "#/components/parameters/version" }
],
"security": [ { "session": [] } ],
"responses": {
"200": { "description": "Successful completion." },
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": ["Upload"]
}
},
"/permissions/{project}": {
"put": {
"summary": "Set the permissions for a project. This requires project owner privileges. If a property is missing in the response, the value in the existing permissions is used without modification.",
"parameters": [
{ "$ref": "#/components/parameters/project" }
],
"requestBody": {
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/permissions" }
}
}
},
"security": [ { "owner": [], "admin": [] } ],
"responses": {
"200": { "description": "Successful change to the project permissions." },
"400": {
"description": "Incorrectly formatted request.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/error" }
}
}
},
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": [ "Permissions" ]
}
},
"/quota/{project}": {
"put": {
"summary": "Set the quota for a project. This requires administrator privileges. Properties are only modified if supplied in the request; otherwise, existing values are used.",
"parameters": [
{ "$ref": "#/components/parameters/project" }
],
"requestBody": {
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/quota" }
}
}
},
"security": [ { "admin": [] } ],
"responses": {
"200": { "description": "Successful change to the project quota." },
"400": {
"description": "Incorrectly formatted request.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/error" }
}
}
},
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": [ "Permissions" ]
}
},
"/probation/approve/{project}/{asset}/{version}": {
"post": {
"summary": "Approve a probational upload. This requires project owner privileges.",
"parameters": [
{ "$ref": "#/components/parameters/project" },
{ "$ref": "#/components/parameters/asset" },
{ "$ref": "#/components/parameters/version" }
],
"security": [ { "owner": [], "admin": [] } ],
"responses": {
"200": { "description": "Successful approval.." },
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": ["Probation"]
}
},
"/probation/reject/{project}/{asset}/{version}": {
"post": {
"summary": "Reject a probational upload. This requires project owner privileges.",
"parameters": [
{ "$ref": "#/components/parameters/project" },
{ "$ref": "#/components/parameters/asset" },
{ "$ref": "#/components/parameters/version" }
],
"security": [ { "owner": [], "admin": [] } ],
"responses": {
"200": { "description": "Successful approval.." },
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": ["Probation"]
}
},
"/credentials/s3-api": {
"get": {
"summary": "Get the key and secret for public read-only S3 API access to the R2 bucket.",
"responses": {
"200": {
"description": "S3 credentials for public read-only access.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [ "endpoint", "bucket", "key", "secret" ],
"properties": {
"endpoint": {
"type": "string",
"description": "Endpoint URL for the S3-compatible API."
},
"bucket": {
"type": "string",
"description": "Name of the bucket."
},
"key": {
"type": "string",
"description": "Access key ID."
},
"secret": {
"type": "string",
"description": "Secret access key."
}
}
}
}
}
}
},
"tags": [ "Permissions" ]
}
},
"/credentials/github-app": {
"get": {
"summary": "Get the GitHub app ID and secret for the Oauth2 flow.",
"responses": {
"200": {
"description": "GitHub app credentials for user authentication.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [ "id", "secret" ],
"properties": {
"id": {
"type": "string",
"description": "Github app ID."
},
"secret": {
"type": "string",
"description": "App secret."
}
}
}
}
}
}
},
"tags": [ "Permissions" ]
}
},
"/refresh/latest/{project}/{asset}": {
"post": {
"summary": "Recompute the latest version for a project's asset, if it gets out of sync. This requires administrator privileges.",
"parameters": [
{ "$ref": "#/components/parameters/project" },
{ "$ref": "#/components/parameters/asset" }
],
"security": [ { "admin": [] } ],
"responses": {
"200": {
"description": "Successful recalculation of the latest version.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "Name of the latest non-probational version. If absent, there are no non-probational versions for this asset."
}
}
}
}
}
},
"400": {
"description": "Project does not exist.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/error" }
}
}
},
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": [ "Refresh" ]
}
},
"/refresh/usage/{project}": {
"post": {
"summary": "Recompute the used quota for a project, if it gets out of sync. This requires administrator privileges.",
"parameters": [
{ "$ref": "#/components/parameters/project" }
],
"security": [ { "admin": [] } ],
"responses": {
"200": { "description": "Successful recalculation of the project's usage." },
"400": {
"description": "Project does not exist.",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [ "total" ],
"properties": {
"total": {
"type": "integer",
"description": "Total usage of this project, in bytes."
}
}
}
}
}
},
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": [ "Refresh" ]
}
},
"/unlock/{project}": {
"delete": {
"summary": "Unlock a project. This is occasionally necessary, e.g., due to an incomplete upload that was not properly aborted.",
"parameters": [
{ "$ref": "#/components/parameters/project" }
],
"security": [ { "admin": [] } ],
"responses": {
"200": { "description": "Successful removal of the lock. This is reported even if `project` does not exist or has no lock." },
"401": { "$ref": "#/components/responses/401" },
"403": { "$ref": "#/components/responses/403" }
},
"tags": [ "Refresh" ]
}
},
"/file/{key}": {
"get": {
"summary": "Download the file with the specified key in the bucket. This is a REST-based replacement for `get-object` from the AWS S3 API.",
"parameters": [
{ "$ref": "#/components/parameters/key" }
],
"responses": {
"200": { "description": "Contents of the requested file." },
"404": { "$ref": "#/components/responses/404" }
},
"tags": [ "Read-only" ]
},
"head": {
"summary": "Obtain metadata about the specified key in the bucket.",
"parameters": [
{ "$ref": "#/components/parameters/key" }
],
"responses": {
"200": { "description": "Metadata for the requested file." },
"404": { "$ref": "#/components/responses/404" }
},
"tags": [ "Read-only" ]
}
},
"/list": {
"get": {
"summary": "List the contents of the bucket, possibly with a prefix. This is a REST-based replacement for `list-objects-v2` from the AWS S3 API.",
"parameters": [
{
"in": "query",
"name": "prefix",
"schema": {
"type": "string"
},
"description": "URL-encoded prefix of the keys to be listed. To represent a \"directory\", the decoded prefix should end with a forward slash.",
"required": false
},
{
"in": "query",
"name": "recursive",
"schema": {
"type": "boolean",
"default": false
},
"description": "Whether to list keys \"recursively\", treating slash-separated components of the key as subdirectories. If true, all keys (or all keys starting with `prefix`, if supplied) are listed. If false, keys are only listed if there are no more slashes after `prefix`; otherwise, the slash-delimited common prefix is shown (i.e., the \"subdirectory\" path).",
"required": false
}
],
"responses": {
"200": {
"description": "All keys (or common prefixes) in the bucket that start with `prefix`.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
},
"tags": [ "Read-only" ]
}
}
},
"components": {
"parameters": {
"project": {
"in": "path",
"name": "project",
"schema": {
"type": "string"
},
"description": "Name of the project. This should not contain '/' or start with '..'.",
"required": true
},
"asset": {
"in": "path",
"name": "asset",
"schema": {
"type": "string"
},
"description": "Name of the asset inside a project. This should not contain '/' or start with '..'.",
"required": true
},
"version": {
"in": "path",
"name": "version",
"schema": {
"type": "string"
},
"description": "Name of the version of the asset inside a project. This should not contain '/' or start with '..'.",
"required": true
},
"key": {
"in": "path",
"name": "key",
"schema": {
"type": "string"
},
"description": "URL-encoded key of the file.",
"required": true
}
},
"responses": {
"401": {
"description": "No token supplied.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/error" }
}
}
},
"403": {
"description": "User is not authorized to perform this operation.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/error" }
}
}
},
"404": {
"description": "Entity does not exist.",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/error" }
}
}
}
},
"schemas": {
"error": {
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": ["error"]
},
"reason": {
"type": "string",
"description": "Reason for the error"
}
}
},
"permissions": {
"type": "object",
"description": "Permissions for the project.",
"properties": {
"owners": {
"description": "GitHub logins of the project owners. Names of GitHub organizations are also allowed, in which case all public members of the organization are considered to be owners.",
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"uploaders": {
"description": "GitHub logins of authorized uploaders. Names of GitHub organizations are also allowed, in which case all public members of the organization are authorized as uploaders.",
"type": "array",
"items": {
"type": "object",
"required": [ "id" ],
"properties": {
"id": {
"type": "string",
"description": "GitHub login or organization name."
},
"asset": {
"type": "string",
"description": "Name of the asset to limit uploads to. If not provided, uploads can be performed to any asset in the project."
},
"version": {
"type": "string",
"description": "Name of the version to limit uploads to. If not provided, uploads can be performed to any version in the project."
},
"until": {
"type": "string",
"description": "Lifetime of the upload authorization. If not provided, the authorization lasts indefinitely.",
"format": "date-time"
},
"trusted": {
"type": "boolean",
"description": "Whether this uploader is to be trusted. If false, all uploads from this user are probational.",
"default": false
}
}
},
"default": []
}
}
},
"quota": {
"type": "object",
"description": "Storage quota for the project.",
"properties": {
"baseline": {
"type": "integer",
"description": "Baseline quota for the project, in terms of the number of bytes. This is equivalent to the quota at project creation.",
"default": 10000000000
},
"growth_rate": {
"type": "integer",
"description": "Growth rate for the project, in terms of the number of bytes per year.",
"default": 20000000000
},
"year": {
"type": "integer",
"description": "Year of creation for the project. Defaults to the current calendar year.",
"example": [ 2023 ]
}
}
}
},
"securitySchemes": {
"admin": {
"type": "http",
"scheme": "bearer",
"description": "GitHub token for an account that gypsum recognizes as an administrator."
},
"uploader": {
"type": "http",
"scheme": "bearer",
"description": "GitHub token for an account that is authorized as an uploader for the specified project."
},
"owner": {
"type": "http",
"scheme": "bearer",
"description": "GitHub token for an account that is listed as an owner for the specified project."
},
"session": {
"type": "http",
"scheme": "bearer",
"description": "Token for an upload session."
}
}
}
}