generated from titan-data/template
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathtitan.yml
1031 lines (1020 loc) · 28 KB
/
titan.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
openapi: 3.0.2
info:
title: Titan API
description: API used by the Titan CLI
version: 0.3.0
servers:
- url: http://localhost:5001
paths:
#
# Context APIs.
#
/v1/context:
get:
summary: Get current context
operationId: getContext
tags:
- contexts
responses:
"200":
description: Current context
content:
application/json:
schema:
$ref: "#/components/schemas/context"
#
# Repository APIs
#
/v1/repositories:
get:
summary: List repositories
operationId: listRepositories
tags:
- repositories
responses:
"200":
description: List of repositories
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/repository"
default:
$ref: "#/components/responses/apiError"
post:
summary: Create new repository
operationId: createRepository
tags:
- repositories
requestBody:
description: New repository to create
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/repository"
responses:
"201":
description: Newly created repository
content:
application/json:
schema:
$ref: "#/components/schemas/repository"
"401":
$ref: "#/components/responses/badInput"
default:
$ref: "#/components/responses/apiError"
/v1/repositories/{repositoryName}:
parameters:
- $ref: "#/components/parameters/repositoryName"
get:
summary: Get info for a repository
operationId: getRepository
tags:
- repositories
responses:
"200":
description: Repository info
content:
application/json:
schema:
$ref: "#/components/schemas/repository"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
post:
summary: Update or rename a repository
operationId: updateRepository
tags:
- repositories
requestBody:
description: New repository
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/repository"
responses:
"200":
description: Updated repository
content:
application/json:
schema:
$ref: "#/components/schemas/repository"
"401":
$ref: "#/components/responses/badInput"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
delete:
summary: Remove a repository
operationId: deleteRepository
tags:
- repositories
responses:
"204":
description: Repository deleted
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
/v1/repositories/{repositoryName}/status:
parameters:
- $ref: "#/components/parameters/repositoryName"
get:
summary: Get current status of a repository
operationId: getRepositoryStatus
tags:
- repositories
responses:
"200":
description: Repository status
content:
application/json:
schema:
$ref: "#/components/schemas/repositoryStatus"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
#
# Volume APIs.
#
/v1/repositories/{repositoryName}/volumes:
parameters:
- $ref: "#/components/parameters/repositoryName"
get:
summary: List volumes
operationId: listVolumes
tags:
- volumes
responses:
"200":
description: List of volumes
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/volume"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
post:
summary: Create new volume
operationId: createVolume
tags:
- volumes
requestBody:
description: New volume to create
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/volume"
responses:
"201":
description: Newly created volume
content:
application/json:
schema:
$ref: "#/components/schemas/volume"
"401":
$ref: "#/components/responses/badInput"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
/v1/repositories/{repositoryName}/volumes/{volumeName}:
parameters:
- $ref: "#/components/parameters/repositoryName"
- $ref: "#/components/parameters/volumeName"
get:
summary: Get info for a volume
operationId: getVolume
tags:
- volumes
responses:
"200":
description: Volume info
content:
application/json:
schema:
$ref: "#/components/schemas/volume"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
delete:
summary: Remove a volume
operationId: deleteVolume
tags:
- volumes
responses:
"204":
description: Volume deleted
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
/v1/repositories/{repositoryName}/volumes/{volumeName}/activate:
parameters:
- $ref: "#/components/parameters/repositoryName"
- $ref: "#/components/parameters/volumeName"
post:
summary: Activate a volume for use by a repository (e.g. mount)
operationId: activateVolume
tags:
- volumes
responses:
"204":
description: Activated repository
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
/v1/repositories/{repositoryName}/volumes/{volumeName}/deactivate:
parameters:
- $ref: "#/components/parameters/repositoryName"
- $ref: "#/components/parameters/volumeName"
post:
summary: Deactivate a volume prior to its deletion (e.g. unmount)
operationId: deactivateVolume
tags:
- volumes
responses:
"204":
description: Deactivated repository
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
/v1/repositories/{repositoryName}/volumes/{volumeName}/status:
parameters:
- $ref: "#/components/parameters/repositoryName"
- $ref: "#/components/parameters/volumeName"
get:
summary: Get status of a volume
operationId: getVolumeStatus
tags:
- volumes
responses:
"200":
description: Volume status
content:
application/json:
schema:
$ref: "#/components/schemas/volumeStatus"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
#
# Commit APIs
#
/v1/repositories/{repositoryName}/commits:
parameters:
- $ref: "#/components/parameters/repositoryName"
get:
summary: Get commit history for a repository
operationId: listCommits
tags:
- commits
parameters:
- $ref: "#/components/parameters/tagQuery"
responses:
"200":
description: List of commits
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/commit"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
post:
summary: Create new commit
operationId: createCommit
tags:
- commits
requestBody:
description: "New commit to create"
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/commit"
responses:
"201":
description: Newly created commit
content:
application/json:
schema:
$ref: "#/components/schemas/commit"
"401":
$ref: "#/components/responses/badInput"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
/v1/repositories/{repositoryName}/commits/{commitId}:
parameters:
- $ref: "#/components/parameters/repositoryName"
- $ref: "#/components/parameters/commitId"
get:
summary: Get information for a specific commit
operationId: getCommit
tags:
- commits
responses:
"200":
description: Commit information
content:
application/json:
schema:
$ref: "#/components/schemas/commit"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
delete:
summary: Discard a past commit
operationId: deleteCommit
tags:
- commits
responses:
"204":
description: Commit discarded
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
post:
summary: Update tags for a previous commit
operationId: updateCommit
tags:
- commits
requestBody:
description: "Commit contents to update"
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/commit"
responses:
"200":
description: Updated commit
content:
application/json:
schema:
$ref: "#/components/schemas/commit"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
/v1/repositories/{repositoryName}/commits/{commitId}/status:
parameters:
- $ref: "#/components/parameters/repositoryName"
- $ref: "#/components/parameters/commitId"
get:
summary: Get commit status
operationId: getCommitStatus
tags:
- commits
responses:
"200":
description: Commit status
content:
application/json:
schema:
$ref: "#/components/schemas/commitStatus"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
/v1/repositories/{repositoryName}/commits/{commitId}/checkout:
parameters:
- $ref: "#/components/parameters/repositoryName"
- $ref: "#/components/parameters/commitId"
post:
summary: Checkout the given commit
operationId: checkoutCommit
tags:
- commits
responses:
"204":
description: Commit checked out
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
#
# Remote APIs.
#
/v1/repositories/{repositoryName}/remotes:
parameters:
- $ref: "#/components/parameters/repositoryName"
get:
summary: Get list of remotes
operationId: listRemotes
tags:
- remotes
responses:
"200":
description: List of remotes
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/remote"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
post:
summary: Create new remote
operationId: createRemote
tags:
- remotes
requestBody:
description: "Remote to create"
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/remote"
responses:
"201":
description: Newly created remote
content:
application/json:
schema:
$ref: "#/components/schemas/remote"
"401":
$ref: "#/components/responses/badInput"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
/v1/repositories/{repositoryName}/remotes/{remoteName}:
parameters:
- $ref: "#/components/parameters/repositoryName"
- $ref: "#/components/parameters/remoteName"
get:
summary: Get information about a particular remote
operationId: getRemote
tags:
- remotes
responses:
"200":
description: Remote information
content:
application/json:
schema:
$ref: "#/components/schemas/remote"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
post:
summary: Update remote information
operationId: updateRemote
tags:
- remotes
requestBody:
description: "Remote information to update"
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/remote"
responses:
"200":
description: Remote information
content:
application/json:
schema:
$ref: "#/components/schemas/remote"
"401":
$ref: "#/components/responses/badInput"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
delete:
summary: Delete remote
operationId: deleteRemote
tags:
- remotes
responses:
"204":
description: Remote deleted
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
/v1/repositories/{repositoryName}/remotes/{remoteName}/commits:
parameters:
- $ref: "#/components/parameters/repositoryName"
- $ref: "#/components/parameters/remoteName"
- $ref: "#/components/parameters/remoteParameters"
get:
summary: List remote commits
operationId: listRemoteCommits
tags:
- remotes
parameters:
- $ref: "#/components/parameters/tagQuery"
responses:
"200":
description: List of commits
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/commit"
"401":
$ref: "#/components/responses/badInput"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
/v1/repositories/{repositoryName}/remotes/{remoteName}/commits/{commitId}:
parameters:
- $ref: "#/components/parameters/repositoryName"
- $ref: "#/components/parameters/remoteName"
- $ref: "#/components/parameters/commitId"
- $ref: "#/components/parameters/remoteParameters"
get:
summary: Get a remote commit
operationId: getRemoteCommit
tags:
- remotes
responses:
"200":
description: Remote commit
content:
application/json:
schema:
$ref: "#/components/schemas/commit"
"401":
$ref: "#/components/responses/badInput"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
#
# Operation APIs.
#
/v1/operations:
get:
summary: List operations
operationId: listOperations
tags:
- operations
parameters:
- name: repository
description: Limit to the given repository
in: query
schema:
type: string
responses:
"200":
description: List of operations
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/operation"
default:
$ref: "#/components/responses/apiError"
/v1/operations/{operationId}:
parameters:
- $ref: "#/components/parameters/operationId"
get:
summary: Get operation
operationId: getOperation
tags:
- operations
responses:
"200":
description: Operation information
content:
application/json:
schema:
$ref: "#/components/schemas/operation"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
delete:
summary: Abort operation
operationId: abortOperation
tags:
- operations
parameters:
- $ref: "#/components/parameters/operationId"
responses:
"204":
description: Operation aborted
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
/v1/operations/{operationId}/progress:
parameters:
- $ref: "#/components/parameters/operationId"
get:
summary: Get operation progress
operationId: getOperationProgress
tags:
- operations
parameters:
- name: lastId
in: query
schema:
type: integer
description: Only return entries with an id greater than this value
responses:
"200":
description: Operation progress information
content:
application/json:
schema:
type: array
items:
$ref: "#/components/schemas/progressEntry"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
/v1/repositories/{repositoryName}/remotes/{remoteName}/commits/{commitId}/pull:
parameters:
- $ref: "#/components/parameters/repositoryName"
- $ref: "#/components/parameters/remoteName"
- $ref: "#/components/parameters/commitId"
post:
summary: Start a pull operation
operationId: pull
tags:
- operations
parameters:
- $ref: "#/components/parameters/metadataOnlyQuery"
requestBody:
description: Provider specific parameters
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/remoteParameters"
responses:
"201":
description: New operation
content:
application/json:
schema:
$ref: "#/components/schemas/operation"
"401":
$ref: "#/components/responses/badInput"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
/v1/repositories/{repositoryName}/remotes/{remoteName}/commits/{commitId}/push:
parameters:
- $ref: "#/components/parameters/repositoryName"
- $ref: "#/components/parameters/remoteName"
- $ref: "#/components/parameters/commitId"
post:
summary: Start a push operation
operationId: push
tags:
- operations
parameters:
- $ref: "#/components/parameters/metadataOnlyQuery"
requestBody:
description: Provider specific parameters
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/remoteParameters"
responses:
"201":
description: New operation
content:
application/json:
schema:
$ref: "#/components/schemas/operation"
"401":
$ref: "#/components/responses/badInput"
"404":
$ref: "#/components/responses/noSuchObject"
default:
$ref: "#/components/responses/apiError"
components:
schemas:
commit:
type: object
properties:
id:
type: string
description: Commit identifier
properties:
type: object
description: Additional commit metadata
required:
- id
- properties
commitStatus:
type: object
properties:
logicalSize:
type: integer
format: int64
description: Logical size of data referenced by commit
actualSize:
type: integer
format: int64
description: Actual size of data referenced by commit
uniqueSize:
type: integer
format: int64
description: Amount of data uniquely held by this commit
ready:
type: boolean
description: Whether this commit can be used as the source of an operation or whether it's still being created
error:
type: string
description: If commit failed to be created, error string explaining why
required:
- logicalSize
- actualSize
- uniqueSize
- ready
context:
type: object
properties:
provider:
type: string
description: Provider type
properties:
type: object
description: Additional provider-specific configuration
required:
- provider
- properties
apiError:
type: object
properties:
code:
type: string
description: Unique code for the error
message:
type: string
description: Human readable description of the error
details:
type: string
description: Additional details, such as server-side stack trace
required:
- message
operation:
type: object
properties:
id:
type: string
description: Unique identifier for the operation
type:
type: string
description: Operation type
enum:
- PUSH
- PULL
state:
type: string
description: Current operation state
enum:
- RUNNING
- ABORTED
- FAILED
- COMPLETE
remote:
type: string
description: Name of remote associated with the operation
commitId:
type: string
description: Commit identifier being pushed or pulled
required:
- id
- type
- state
- remote
- commitId
progressEntry:
type: object
properties:
id:
type: integer
description: Sequenced entry identifier
type:
type: string
description: Entry type
enum:
- MESSAGE
- START
- PROGRESS
- END
- ERROR
- ABORT
- FAILED
- COMPLETE
message:
type: string
description: Optional message for progress step
percent:
type: integer
description: Optional percent for step
minimum: 0
maximum: 100
required:
- id
- type
remote:
type: object
properties:
provider:
type: string
description: Remote type
name:
type: string
description: Name of remote
properties:
type: object
description: Provider-specific remote properties
required:
- provider
- name
- properties
remoteParameters:
type: object
properties:
provider:
type: string
description: Remote type
properties:
type: object
description: Provider-specific remote properties
required:
- provider
- properties
repository:
type: object
properties:
name:
type: string
description: Repository name
properties:
type: object
description: Client-specific properties
required:
- name
- properties
repositoryStatus:
type: object
properties:
lastCommit:
type: string
description: The latest commit ID for the repository
sourceCommit:
type: string
description: The source commit for the current state (last checkout or commit)
volume:
type: object
properties:
name:
type: string
description: Volume name
properties:
type: object
description: Client-specific properties
config:
type: object
description: Server-generated configuration
required:
- name
- properties
volumeStatus:
type: object
properties:
name:
type: string
description: Volume name
logicalSize:
type: integer
format: int64
description: Logical size consumed by the volume
actualSize:
type: integer
format: int64
description: Actual (compressed) size used by the volume
properties:
type: object
description: Client-specific properties
ready:
type: boolean
description: True if the volume is ready for use in a runtime environmemnt
error:
type: string
description: Optional error message if volume asynchronously failed to be created
required:
- name
- logicalSize
- actualSize
- properties
- ready
responses:
apiError:
description: An internal error occurred
content:
application/json:
schema:
$ref: "#/components/schemas/apiError"
badInput:
description: Malformed user input
content:
application/json:
schema:
$ref: "#/components/schemas/apiError"
noSuchObject:
description: No such object
content:
application/json:
schema:
$ref: "#/components/schemas/apiError"
parameters:
repositoryName:
name: repositoryName
in: path
required: true
description: Name of the repository
schema:
type: string
remoteName:
name: remoteName
in: path
required: true
description: Name of the remote
schema:
type: string
commitId:
name: commitId
in: path
required: true
description: Commit identifier
schema:
type: string
operationId:
name: operationId
in: path
required: true