aboutsummaryrefslogtreecommitdiff
path: root/doc/api/garage-admin-v1.yml
blob: 063bc3826c6e3c4a3adf3daf6076a66efbc57134 (plain) (blame)
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
openapi: 3.0.0
info:
  version: v0.9.0
  title: Garage Administration API v0+garage-v0.9.0
  description: |
    Administrate your Garage cluster programatically, including status, layout, keys, buckets, and maintainance tasks.
    
    *Disclaimer: The API is not stable yet, hence its v0 tag. The API can change at any time, and changes can include breaking backward compatibility. Read the changelog and upgrade your scripts before upgrading. Additionnaly, this specification is very early stage and can contain bugs, especially on error return codes/types that are not tested yet. Do not expect a well finished and polished product!*
paths: 
  /status:
    get:
      tags: 
        - Nodes
      operationId: "GetNodes"
      summary: "Status of this node and other nodes in the cluster"
      description: |
        Returns the cluster's current status, including:
         - ID of the node being queried and its version of the Garage daemon
         - Live nodes
         - Currently configured cluster layout
         - Staged changes to the cluster layout

        *Capacity is given in bytes*
      responses:
        '500':
          description: |
            The server can not answer your request because it is in a bad state
        '200':
          description: |
            Information about the queried node, its environment and the current layout
          content:
            application/json:
              schema:
                type: object
                required: [ node, garageVersion, garageFeatures, rustVersion, dbEngine, knownNodes, layout ]
                properties:
                  node: 
                    type: string
                    example: "ec79480e0ce52ae26fd00c9da684e4fa56658d9c64cdcecb094e936de0bfe71f"
                  garageVersion:
                    type: string
                    example: "v0.9.0"
                  garageFeatures:
                    type: array
                    items:
                      type: string
                    example:
                      - "k2v"
                      - "sled"
                      - "lmdb"
                      - "sqlite"
                      - "consul-discovery"
                      - "kubernetes-discovery"
                      - "metrics"
                      - "telemetry-otlp"
                      -  "bundled-libs"
                  rustVersion:
                    type: string
                    example: "1.68.0"
                  dbEngine:
                    type: string
                    example: "LMDB (using Heed crate)"
                  knownNodes:
                    type: array
                    example:
                      - id: "ec79480e0ce52ae26fd00c9da684e4fa56658d9c64cdcecb094e936de0bfe71f"
                        addr: "10.0.0.11:3901"
                        isUp: true
                        lastSeenSecsAgo: 9
                        hostname: orion
                      - id: "4a6ae5a1d0d33bf895f5bb4f0a418b7dc94c47c0dd2eb108d1158f3c8f60b0ff"
                        addr: "10.0.0.12:3901"
                        isUp: true
                        lastSeenSecsAgo: 13
                        hostname: pegasus
                      - id: "e2ee7984ee65b260682086ec70026165903c86e601a4a5a501c1900afe28d84b"
                        addr: "10.0.0.13:3901"
                        isUp: true
                        lastSeenSecsAgo: 2
                        hostname: neptune
                    items:
                      $ref: '#/components/schemas/NodeNetworkInfo'
                  layout:
                    $ref: '#/components/schemas/ClusterLayout'
                          
  /connect:
    post:
      tags:
        - Nodes
      operationId: "AddNode"
      summary: "Connect target node to other Garage nodes"
      description: |
        Instructs this Garage node to connect to other Garage nodes at specified `<node_id>@<net_address>`. `node_id` is generated automatically on node start.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              example:
                - "ec79480e0ce52ae26fd00c9da684e4fa56658d9c64cdcecb094e936de0bfe71f@10.0.0.11:3901"
                - "4a6ae5a1d0d33bf895f5bb4f0a418b7dc94c47c0dd2eb108d1158f3c8f60b0ff@10.0.0.12:3901"
              items:
                type: string
                
      responses:
        '500':
          description: |
            The server can not answer your request because it is in a bad state
        '400':
          description: |
            Your request is malformed, check your JSON
        '200':
          description: |
            The request has been handled correctly but it does not mean that all connection requests succeeded; some might have fail, you need to check the body!
          content:
            application/json:
              schema:
                type: array
                example:
                  - success: true
                    error:
                  - success: false
                    error: "Handshake error"
                items:
                  type: object
                  properties:
                    success:
                      type: boolean
                      example: true
                    error:
                      type: string
                      nullable: true
                      example: 
                
  /layout:
    get:
      tags:
        - Layout
      operationId: "GetLayout"
      summary: "Details on the current and staged layout"
      description: |
        Returns the cluster's current layout, including:
          - Currently configured cluster layout
          - Staged changes to the cluster layout
          
        *Capacity is given in bytes*
        *The info returned by this endpoint is a subset of the info returned by `GET /status`.*
      responses:
        '500':
          description: |
            The server can not answer your request because it is in a bad state
        '200':
          description: |
            Returns the cluster's current cluster layout:
              - Currently configured cluster layout
              - Staged changes to the cluster layout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterLayout'
                
    post:
      tags:
        - Layout
      operationId: "AddLayout"
      summary: "Send modifications to the cluster layout"
      description: |
        Send modifications to the cluster layout. These modifications will be included in the staged role changes, visible in subsequent calls of `GET /layout`. Once the set of staged changes is satisfactory, the user may call `POST /layout/apply` to apply the changed changes, or `POST /layout/revert` to clear all of the staged changes in the layout.

        Setting the capacity to `null` will configure the node as a gateway.
        Otherwise, capacity must be now set in bytes (before Garage 0.9 it was arbitrary weights).
        For example to declare 100GB, you must set `capacity: 100000000000`.

        Garage uses internally the International System of Units (SI), it assumes that 1kB = 1000 bytes, and displays storage as kB, MB, GB (and not KiB, MiB, GiB that assume 1KiB = 1024 bytes).
      requestBody:
        description: |
          To add a new node to the layout or to change the configuration of an existing node, simply set the values you want (`zone`, `capacity`, and `tags`).
          To remove a node, simply pass the `remove: true` field.
          This logic is represented in OpenAPI with a "One Of" object.
        
          Contrary to the CLI that may update only a subset of the fields capacity, zone and tags, when calling this API all of these values must be specified.
        required: true
        content:
          application/json:
            schema:
              type: array
              example:
                - id: "e2ee7984ee65b260682086ec70026165903c86e601a4a5a501c1900afe28d84b"
                  zone: "geneva"
                  capacity: 100000000000
                  tags:
                    - gateway
                - id: "4a6ae5a1d0d33bf895f5bb4f0a418b7dc94c47c0dd2eb108d1158f3c8f60b0ff"
                  remove: true
              items:
                $ref: '#/components/schemas/NodeRoleChange'
      responses:
        '500':
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "Invalid syntax or requested change"
        '200':
          description: "The layout modification has been correctly staged"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClusterLayout'
          
  /layout/apply:
    post:
      tags:
        - Layout
      operationId: "ApplyLayout"
      summary: "Apply staged layout"
      description: |
        Applies to the cluster the layout changes currently registered as staged layout changes.

        *Note: do not try to parse the `message` field of the response, it is given as an array of string specifically because its format is not stable.*
      requestBody:
        description: |
          Similarly to the CLI, the body must include the version of the new layout that will be created, which MUST be 1 + the value of the currently existing layout in the cluster.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LayoutVersion'
              
      responses:
        '500':
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "Invalid syntax or requested change"
        '200':
          description: "The staged layout has been applied as the new layout of the cluster, a rebalance has been triggered."
          content:
            application/json:
              schema:
                type: object
                required: [ message, layout ]
                properties:
                  message:
                    type: array
                    items:
                      type: string
                    example:
                      - "==== COMPUTATION OF A NEW PARTITION ASSIGNATION ===="
                      - ""
                      - "Partitions are replicated 1 times on at least 1 distinct zones."
                      - ""
                      - "Optimal partition size:                     419.4 MB (3 B in previous layout)"
                      - "Usable capacity / total cluster capacity:   107.4 GB / 107.4 GB (100.0 %)"
                      - "Effective capacity (replication factor 1):  107.4 GB"
                      - ""
                      - "A total of 0 new copies of partitions need to be transferred."
                      - ""
                      - "dc1                 Tags  Partitions        Capacity  Usable capacity\n  6a8e08af2aab1083  a,v   256 (0 new)       107.4 GB  107.4 GB (100.0%)\n  TOTAL                   256 (256 unique)  107.4 GB  107.4 GB (100.0%)\n\n"
                  layout:
                    $ref: '#/components/schemas/ClusterLayout'

          
  /layout/revert:
    post:
      tags:
        - Layout
      operationId: "RevertLayout"
      summary: "Clear staged layout"
      description: |
        Clears all of the staged layout changes.
      requestBody:
        description: |
          Reverting the staged changes is done by incrementing the version number and clearing the contents of the staged change list. Similarly to the CLI, the body must include the incremented version number, which MUST be 1 + the value of the currently existing layout in the cluster.
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LayoutVersion'
      responses:
        '500':
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "Invalid syntax or requested change"
        '200':
          description: "The staged layout has been cleared, you can start again sending modification from a fresh copy with `POST /layout`."
          
  "/key?list":
    get:
      tags:
        - Key
      operationId: "ListKeys"
      summary: "List all keys"
      description: |
        Returns all API access keys in the cluster.
      responses:
        '500':
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '200':
          description: |
            Returns the key identifier (aka `AWS_ACCESS_KEY_ID`) and its associated, human friendly, name if any (otherwise return an empty string)
          content:
            application/json:
              schema:
                type: array
                example:
                  - id: "GK31c2f218a2e44f485b94239e"
                    name: "test-key"
                  - id: "GKe10061ac9c2921f09e4c5540"
                    name: ""
                items:
                  type: object
                  required: [ id ]
                  properties:
                    id:
                      type: string
                    name:
                      type: string
    post:
      tags:
        - Key
      operationId: "AddKey"
      summary: "Create a new API key"
      description: |
        Creates a new API access key.
      requestBody:
        description: |
          You can set a friendly name for this key.
          If you don't want to, you can set the name to `null`.
        
          *Note: the secret key is returned in the response.*
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  nullable: true
                  example: "test-key"
      responses:
        '500':
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "Invalid syntax or requested change"
        '200':
          description: "The key has been added"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyInfo'

  "/key":
    get:
      tags:
        - Key
      operationId: "GetKey"
      summary: "Get key information"
      description: |
        Return information about a specific key like its identifiers, its permissions and buckets on which it has permissions. 
        You can search by specifying the exact key identifier (`id`) or by specifying a pattern (`search`).

        For confidentiality reasons, the secret key is not returned by default: you must pass the `showSecretKey` query parameter to get it.
      parameters:
        - name: id
          in: query
          description: |
            The exact API access key generated by Garage.

            Incompatible with `search`.
          example: "GK31c2f218a2e44f485b94239e"
          schema:
            type: string
        - name: search
          in: query
          description: |
            A pattern (beginning or full string) corresponding to a key identifier or friendly name.

            Incompatible with `id`.
          example: "test-k"
          schema:
            type: string
        - name: showSecretKey
          in: query
          schema:
            type: string
            default: "false"
            enum:
              - "true"
              - "false"
          example: "true"
          required: false
          description: "Wether or not the secret key should be returned in the response"
      responses:
        '500':
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '200':
          description: |
            Returns information about the key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyInfo'
              
    delete:
      tags: 
        - Key
      operationId: "DeleteKey"
      summary: "Delete a key"
      description: |
       Delete a key from the cluster. Its access will be removed from all the buckets. Buckets are not automatically deleted and can be dangling. You should manually delete them before. 
      parameters:
        - name: id
          in: query
          required: true
          description: "The exact API access key generated by Garage"
          example: "GK31c2f218a2e44f485b94239e"
          schema:
            type: string
      responses:
        '500':
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '200':
          description: "The key has been deleted"

        
    post:
      tags:
        - Key
      operationId: "UpdateKey"
      summary: "Update a key"
      description: |
        Updates information about the specified API access key.

        *Note: the secret key is not returned in the response, `null` is sent instead.*
      parameters:
        - name: id
          in: query
          required: true
          description: "The exact API access key generated by Garage"
          example: "GK31c2f218a2e44f485b94239e"
          schema:
            type: string
      requestBody:
        description: |
          For a given key, provide a first set with the permissions to grant, and a second set with the permissions to remove
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  example: "test-key"
                allow:
                  type: object
                  example:
                  properties:
                    createBucket:
                      type: boolean
                      example: true
                deny:
                  type: object
                  properties:
                    createBucket:
                      type: boolean
                      example: true
      responses:
        '500':
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "Invalid syntax or requested change"
        '200':
          description: |
            Returns information about the key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyInfo'

        
  /key/import:
    post:
      tags:
        - Key
      operationId: "ImportKey"
      summary: "Import an existing key"
      description: |
        Imports an existing API key. This feature must only be used for migrations and backup restore.

        **Do not use it to generate custom key identifiers or you will break your Garage cluster.**
      requestBody:
        description: |
          Information on the key to import
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [ name, accessKeyId, secretAccessKey ]
              properties:
                name:
                  type: string
                  example: "test-key"
                  nullable: true
                accessKeyId:
                  type: string
                  example: "GK31c2f218a2e44f485b94239e"
                secretAccessKey:
                  type: string
                  example: "b892c0665f0ada8a4755dae98baa3b133590e11dae3bcc1f9d769d67f16c3835"
      responses:
        '500':
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "Invalid syntax or requested change"
        '200':
          description: "The key has been imported into the system"
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyInfo' 

  "/bucket?list":
    get:
      tags:
        - Bucket
      operationId: "ListBuckets"
      summary: "List all buckets"
      description: |
        List all the buckets on the cluster with their UUID and their global and local aliases.
      responses:
        '500':
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '200':
          description: |
            Returns the UUID of the bucket and all its aliases
          content:
            application/json:
              schema:
                type: array
                example:
                  - id: "70dc3bed7fe83a75e46b66e7ddef7d56e65f3c02f9f80b6749fb97eccb5e1033"
                    globalAliases: 
                      - "container_registry"
                  - id: "96470e0df00ec28807138daf01915cfda2bee8eccc91dea9558c0b4855b5bf95"
                    localAliases:
                      - alias: "my_documents"
                        accessKeyid: "GK31c2f218a2e44f485b94239e"
                  - id: "d7452a935e663fc1914f3a5515163a6d3724010ce8dfd9e4743ca8be5974f995"
                    globalAliases:
                      - "example.com"
                      - "www.example.com"
                    localAliases:
                      - alias: "corp_website"
                        accessKeyId: "GKe10061ac9c2921f09e4c5540"
                      - alias: "web"
                        accessKeyid: "GK31c2f218a2e44f485b94239e"
                  - id: ""
                items:
                  type: object
                  required: [ id ]
                  properties:
                    id:
                      type: string
                    globalAliases:
                      type: array
                      items:
                        type: string
                    localAliases:
                      type: array
                      items:
                        type: object
                        required: [ alias, accessKeyId ]
                        properties:
                          alias:
                            type: string
                          accessKeyId:
                            type: string

  /bucket:
    post:
      tags:
        - Bucket
      operationId: "CreateBucket"
      summary: "Create a bucket"
      description: |
        Creates a new bucket, either with a global alias, a local one, or no alias at all.
        Technically, you can also specify both `globalAlias` and `localAlias` and that would create two aliases.
      requestBody:
        description: |
          Aliases to put on the new bucket
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [ ]
              properties:
                globalAlias:
                  type: string
                  example: "my_documents"
                localAlias:
                  type: object
                  properties:
                    accessKeyId:
                      type: string
                    alias:
                      type: string
                    allow:
                      type: object
                      properties:
                        read:
                          type: boolean
                          example: true
                        write:
                          type: boolean
                          example: true
                        owner:
                          type: boolean
                          example: true
      responses:
        '500': 
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "The payload is not formatted correctly"
        '200':
          description: Returns exhaustive information about the bucket
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BucketInfo'
    get:
      tags:
        - Bucket
      operationId: "GetBucketInfo"
      summary: "Get a bucket"
      description: |
        Given a bucket identifier (`id`) or a global alias (`alias`), get its information.
        It includes its aliases, its web configuration, keys that have some permissions
        on it, some statistics (number of objects, size), number of dangling multipart uploads,
        and its quotas (if any).
      parameters:
        - name: id
          in: query
          description: |
            The exact bucket identifier, a 32 bytes hexadecimal string.

            Incompatible with `alias`.
          example: "b4018dc61b27ccb5c64ec1b24f53454bbbd180697c758c4d47a22a8921864a87"
          schema:
            type: string
        - name: alias
          in: query
          description: |
            The exact global alias of one of the existing buckets.

            Incompatible with `id`.
          example: "my_documents"
          schema:
            type: string
      responses:
        '500': 
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '404':
          description: "Bucket not found"
        '200':
          description: Returns exhaustive information about the bucket
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BucketInfo'


    delete:
      tags:
        - Bucket
      operationId: "DeleteBucket"
      summary: "Delete a bucket"
      description: |
        Delete a bucket.Deletes a storage bucket. A bucket cannot be deleted if it is not empty.

        **Warning:** this will delete all aliases associated with the bucket!
      parameters:
        - name: id
          in: query
          required: true
          description: "The exact bucket identifier, a 32 bytes hexadecimal string"
          example: "b4018dc61b27ccb5c64ec1b24f53454bbbd180697c758c4d47a22a8921864a87"
          schema:
            type: string
      responses:
        '500': 
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "Bucket is not empty"
        '404':
          description: "Bucket not found"
        '204':
          description: Bucket has been deleted


      
    put:
      tags:
        - Bucket
      operationId: "UpdateBucket"
      summary: "Update a bucket"
      description: |
        All fields (`websiteAccess` and `quotas`) are optional.
        If they are present, the corresponding modifications are applied to the bucket, otherwise nothing is changed.

        In `websiteAccess`: if `enabled` is `true`, `indexDocument` must be specified.
        The field `errorDocument` is optional, if no error document is set a generic
        error message is displayed when errors happen. Conversely, if `enabled` is
        `false`, neither `indexDocument` nor `errorDocument` must be specified.

        In `quotas`: new values of `maxSize` and `maxObjects` must both be specified, or set to `null`
        to remove the quotas. An absent value will be considered the same as a `null`. It is not possible
        to change only one of the two quotas.
      parameters:
        - name: id
          in: query
          required: true
          description: "The exact bucket identifier, a 32 bytes hexadecimal string"
          example: "b4018dc61b27ccb5c64ec1b24f53454bbbd180697c758c4d47a22a8921864a87"
          schema:
            type: string       
      requestBody:
        description: |
          Requested changes on the bucket. Both root fields are optionals.
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [ ]
              properties:
                websiteAccess:
                  type: object
                  properties:
                    enabled: 
                      type: boolean
                      example: true
                    indexDocument:
                      type: string
                      example: "index.html"
                    errorDocument:
                      type: string
                      example: "error/400.html"
                quotas:
                  type: object
                  properties:
                    maxSize: 
                      type: integer
                      format: int64
                      nullable: true
                      example: 19029801
                    maxObjects:
                      type: integer
                      format: int64
                      nullable: true
                      example: null

      responses:
        '500': 
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "Bad request, check your body."
        '404':
          description: "Bucket not found"
        '200':
          description: Returns exhaustive information about the bucket
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BucketInfo'

  /bucket/allow:
    post:
      tags:
        - Bucket
      operationId: "AllowBucketKey"
      summary: "Allow key"
      description: |
        ⚠️ **DISCLAIMER**: Garage's developers are aware that this endpoint has an unconventional semantic. Be extra careful when implementing it, its behavior is not obvious.

        Allows a key to do read/write/owner operations on a bucket.

        Flags in permissions which have the value true will be activated. Other flags will remain unchanged (ie. they will keep their internal value).

        For example, if you set read to true, the key will be allowed to read the bucket.
        If you set it to false, the key will keeps its previous read permission.
        If you want to disallow read for the key, check the DenyBucketKey operation.

      requestBody:
        description: |
          Aliases to put on the new bucket
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [ bucketId, accessKeyId, permissions ]
              properties:
                bucketId:
                  type: string
                  example: "e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b"
                accessKeyId:
                  type: string
                  example: "GK31c2f218a2e44f485b94239e"
                permissions:
                  type: object
                  required: [ read, write, owner ]
                  properties:
                    read:
                      type: boolean
                      example: true
                    write:
                      type: boolean
                      example: true
                    owner:
                      type: boolean
                      example: true
      responses:
        '500': 
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "Bad request, check your request body"
        '404':
          description: "Bucket not found"
        '200':
          description: Returns exhaustive information about the bucket
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BucketInfo'

  /bucket/deny:
    post:
      tags:
        - Bucket
      operationId: "DenyBucketKey"
      summary: "Deny key"
      description: |
        ⚠️ **DISCLAIMER**: Garage's developers are aware that this endpoint has an unconventional semantic. Be extra careful when implementing it, its behavior is not obvious.

        Denies a key from doing read/write/owner operations on a bucket.

        Flags in permissions which have the value true will be deactivated. Other flags will remain unchanged.

        For example, if you set read to true, the key will be denied from reading.
        If you set read to false,  the key will keep its previous permissions.
        If you want the key to have the reading permission, check the AllowBucketKey operation.

      requestBody:
        description: |
          Aliases to put on the new bucket
        required: true
        content:
          application/json:
            schema:
              type: object
              required: [ bucketId, accessKeyId, permissions ]
              properties:
                bucketId:
                  type: string
                  example: "e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b"
                accessKeyId:
                  type: string
                  example: "GK31c2f218a2e44f485b94239e"
                permissions:
                  type: object
                  required: [ read, write, owner ]
                  properties:
                    read:
                      type: boolean
                      example: true
                    write:
                      type: boolean
                      example: true
                    owner:
                      type: boolean
                      example: true
      responses:
        '500': 
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "Bad request, check your request body"
        '404':
          description: "Bucket not found"
        '200':
          description: Returns exhaustive information about the bucket
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BucketInfo'

  /bucket/alias/global:
    put:
      tags:
        - Bucket
      operationId: "PutBucketGlobalAlias"
      summary: "Add a global alias"
      description: |
        Add a global alias to the target bucket
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b
        - name: alias
          in: query
          required: true
          example: my_documents
          schema:
            type: string
      responses:
        '500': 
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "Bad request, check your request body"
        '404':
          description: "Bucket not found"
        '200':
          description: Returns exhaustive information about the bucket
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BucketInfo'

    delete:
      tags:
        - Bucket
      operationId: "DeleteBucketGlobalAlias"
      summary: "Delete a global alias"
      description: |
        Delete a global alias from the target bucket
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b
        - name: alias
          in: query
          required: true
          schema:
            type: string
          example: my_documents
      responses:
        '500': 
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "Bad request, check your request body"
        '404':
          description: "Bucket not found"
        '200':
          description: Returns exhaustive information about the bucket
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BucketInfo'

  /bucket/alias/local:
    put:
      tags:
        - Bucket
      operationId: "PutBucketLocalAlias"
      summary: "Add a local alias"
      description: |
        Add a local alias, bound to specified account, to the target bucket
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b
        - name: accessKeyId
          in: query
          required: true
          schema:
            type: string
          example: GK31c2f218a2e44f485b94239e
        - name: alias
          in: query
          required: true
          schema:
            type: string
          example: my_documents
      responses:
        '500': 
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "Bad request, check your request body"
        '404':
          description: "Bucket not found"
        '200':
          description: Returns exhaustive information about the bucket
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BucketInfo'

    delete:
      tags:
        - Bucket
      operationId: "DeleteBucketLocalAlias"
      summary: "Delete a local alias"
      description: |
        Delete a local alias, bound to specified account, from the target bucket
      parameters:
        - name: id
          in: query
          required: true
          schema:
            type: string
          example: e6a14cd6a27f48684579ec6b381c078ab11697e6bc8513b72b2f5307e25fff9b
        - name: accessKeyId
          in: query
          schema:
            type: string
          required: true
          example: GK31c2f218a2e44f485b94239e
        - name: alias
          in: query
          schema:
            type: string
          required: true
          example: my_documents
      responses:
        '500': 
          description: "The server can not handle your request. Check your connectivity with the rest of the cluster."
        '400':
          description: "Bad request, check your request body"
        '404':
          description: "Bucket not found"
        '200':
          description: Returns exhaustive information about the bucket
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BucketInfo'
        
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
  schemas:
    NodeNetworkInfo:
      type: object
      required: [ addr, isUp, lastSeenSecsAgo, hostname ]
      properties:
        id:
          type: string
          example: "6a8e08af2aab1083ebab9b22165ea8b5b9d333b60a39ecd504e85cc1f432c36f"
        addr:
          type: string
          example: "10.0.0.11:3901"
        isUp:
          type: boolean
          example: true
        lastSeenSecsAgo:
          type: integer
          nullable: true
          example: 9
        hostname:
          type: string
          example: "node1"
    NodeClusterInfo:
      type: object
      required: [ id, zone, tags ]
      properties:
        zone:
          type: string
          example: dc1
        capacity:
          type: integer
          nullable: true
          example: 4
        tags:
          type: array
          description: |
            User defined tags, put whatever makes sense for you, these tags are not interpreted by Garage
          example:
            - gateway
            - fast
          items:
            type: string
    NodeRoleChange:
      oneOf:
        - $ref: '#/components/schemas/NodeRoleRemove'
        - $ref: '#/components/schemas/NodeRoleUpdate'
    NodeRoleRemove:
      type: object
      required: [ remove ]
      properties:
        id:
          type: string
          example: "6a8e08af2aab1083ebab9b22165ea8b5b9d333b60a39ecd504e85cc1f432c36f"
        remove:
          type: boolean
          example: true
    NodeRoleUpdate:
      type: object
      required: [ zone, capacity, tags ]
      properties:
        id:
          type: string
          example: "6a8e08af2aab1083ebab9b22165ea8b5b9d333b60a39ecd504e85cc1f432c36f"
        zone:
          type: string
          example: "dc1"
        capacity:
          type: integer
          nullable: true
          example: 150000000000
        tags:
          type: array
          items:
            type: string
          example:
            - gateway
            - fast

    ClusterLayout:
      type: object
      required: [ version, roles, stagedRoleChanges ]
      properties:
        version:
          type: integer
          example: 12
        roles:
          type: array
          example:
            - id: "ec79480e0ce52ae26fd00c9da684e4fa56658d9c64cdcecb094e936de0bfe71f"
              zone: "madrid"
              capacity: 300000000000
              tags:
                - fast
                - amd64
            - id: "4a6ae5a1d0d33bf895f5bb4f0a418b7dc94c47c0dd2eb108d1158f3c8f60b0ff"
              zone: "geneva"
              capacity: 700000000000
              tags:
                - arm64
          items:
            $ref: '#/components/schemas/NodeClusterInfo'
        stagedRoleChanges:
          type: array
          example:
            - id: "e2ee7984ee65b260682086ec70026165903c86e601a4a5a501c1900afe28d84b"
              zone: "geneva"
              capacity: 800000000000
              tags:
                - gateway
            - id: "4a6ae5a1d0d33bf895f5bb4f0a418b7dc94c47c0dd2eb108d1158f3c8f60b0ff"
              remove: true
          items:
            $ref: '#/components/schemas/NodeRoleChange'
    LayoutVersion:
      type: object
      properties:
        version:
          type: integer
          example: 13
          
    KeyInfo:
      type: object
      properties:
        name:
          type: string
          example: "test-key"
        accessKeyId:
          type: string
          example: "GK31c2f218a2e44f485b94239e"
        secretAccessKey:
          type: string
          nullable: true
          example: "b892c0665f0ada8a4755dae98baa3b133590e11dae3bcc1f9d769d67f16c3835"
        permissions:
          type: object
          properties:
            createBucket:
              type: boolean
              example: false
        buckets:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                example: "70dc3bed7fe83a75e46b66e7ddef7d56e65f3c02f9f80b6749fb97eccb5e1033"
              globalAliases:
                type: array
                items:
                  type: string
                  example: "my-bucket"
              localAliases:
                type: array
                items:
                  type: string
                  example: "GK31c2f218a2e44f485b94239e:localname"
              permissions:
                type: object
                properties:
                  read:
                    type: boolean
                    example: true
                  write:
                    type: boolean
                    example: true
                  owner:
                    type: boolean
                    example: false
    BucketInfo:
      type: object
      properties:
        id:
          type: string
          example: afa8f0a22b40b1247ccd0affb869b0af5cff980924a20e4b5e0720a44deb8d39
        globalAliases:
          type: array
          items:
            type: string
            example: "my_documents"
        websiteAccess:
          type: boolean
          example: true
        websiteConfig:
          type: object
          nullable: true
          properties:
            indexDocument:
              type: string
              example: "index.html"
            errorDocument:
              type: string
              example: "error/400.html"
        keys:
          type: array
          items:
            $ref: '#/components/schemas/BucketKeyInfo'
        objects:
          type: integer
          format: int64
          example: 14827
        bytes:
          type: integer
          format: int64
          example: 13189855625
        unfinishedUploads:
          type: integer
          example: 0
        quotas:
          type: object
          properties:
            maxSize:
              nullable: true
              type: integer
              format: int64
              example: null
            maxObjects:
              nullable: true
              type: integer
              format: int64
              example: null


    BucketKeyInfo:
      type: object
      properties:
        accessKeyId:
          type: string
        name:
          type: string
        permissions:
          type: object
          properties:
            read:
              type: boolean
              example: true
            write:
              type: boolean
              example: true
            owner:
              type: boolean
              example: true
        bucketLocalAliases:
          type: array
          items:
            type: string
            example: "my_documents"


security:
  - bearerAuth: []

servers:
  - description: A local server
    url: http://localhost:3903/v1/