-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathterminusdb.yaml
More file actions
1155 lines (1141 loc) · 33.8 KB
/
terminusdb.yaml
File metadata and controls
1155 lines (1141 loc) · 33.8 KB
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.1
info:
title: TerminusDB API
description: API for TerminusDB
contact:
email: [email protected]
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
version: 10.0.3
externalDocs:
description: Find out more about TerminusDB
url: https://terminusdb.com/docs/
servers:
- url: http://localhost:6363/api/
security:
- basicAuth: []
tags:
- name: TerminusDB
description: Everything about TerminusDB
externalDocs:
description: Find out more
url: https://terminusdb.com
# TODO: Some paths are not covered yet:
# - a lot of the git-like features
paths:
/:
get:
tags:
- connection
summary: Get a list of databases for the authenticated user
responses:
200:
description: successful operation
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Database'
401:
$ref: '#/components/responses/UnauthorizedError'
/info:
get:
tags:
- connection
summary: Get information about the TerminusDB version
responses:
200:
description: succesful operation
content:
application/json:
schema:
type: object
properties:
"@type":
type: string
example: api:InfoResponse
"api:info":
type: object
properties:
"authority":
type: string
example: "terminusdb://system/data/User/admin"
"storage":
type: object
properties:
"version":
type: string
example: "1"
"terminusdb":
type: object
properties:
"version":
type: string
example: "10.0.13"
"terminusdb_store":
type: object
properties:
"version":
type: string
example: "0.19.5"
"api:status":
type: string
example: api:success
/ok:
get:
tags:
- connection
summary: Simple status update
responses:
200:
description: Succeeded
/db/:
get:
tags:
- database
summary: List details of all databases available to the authorized user.
parameters:
- name: branches
in: query
description: Return branches or not
required: false
schema:
type: boolean
default: false
- name: verbose
in: query
description: Return all available information
required: false
schema:
type: boolean
default: false
responses:
200:
description: Database listing
content:
application/json:
schema:
$ref: '#/components/schemas/Database'
404:
description: database not found
content:
application/json:
schema:
type: object
/db/{organization}/{database}:
get:
tags:
- database
summary: List details of the database under the given organization.
parameters:
- $ref: '#/components/parameters/organization'
- $ref: '#/components/parameters/database'
- name: branches
in: query
description: Return branches or not
required: false
schema:
type: boolean
default: false
- name: verbose
in: query
description: Return all available information
required: false
schema:
type: boolean
default: false
responses:
200:
description: Database listing
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Database'
404:
description: Database not found
content:
application/json:
schema:
type: object
head:
tags:
- database
summary: Check that a db exists
parameters:
- $ref: '#/components/parameters/organization'
- $ref: '#/components/parameters/database'
responses:
200:
description: Database exists
content:
application/json:
schema:
type: object
404:
description: Database not found
content:
application/json:
schema:
type: object
post:
tags:
- database
summary: Create a database
parameters:
- $ref: '#/components/parameters/organization'
- $ref: '#/components/parameters/database'
requestBody: # TODO: Missing prefixes
required: true
content:
application/json:
schema:
type: object
properties:
comment:
type: string
example: A sample comment for my database
label:
type: string
example: Testdatabase
public:
type: boolean
example: false
description: Should the database be accessible for all users?
schema:
type: boolean
example: true
description: Should the database be initialized with a schema?
required:
- comment
- label
responses:
200:
description: Added database
content:
application/json:
schema:
type: object
properties:
"@type":
type: string
example: api:DbCreateResponse
"api:status":
type: string
example: api:success
400:
description: Database already exists
content:
application/json:
schema:
type: object
properties:
"@type":
type: string
example: api:DbCreateErrorResponse
"api:error":
type: object
properties:
"@type":
type: string
example: api:DatabaseAlreadyExists
"api:database_name":
type: string
example: MyNewAlreadyExistingDatabase
"api:organization_name":
type: string
example: admin
"api:message":
type: string
example: Database already exists.
"api:status":
type: string
example: api:failure
401:
$ref: '#/components/responses/UnauthorizedError'
delete:
tags:
- database
summary: Delete a database
parameters:
- $ref: '#/components/parameters/organization'
- $ref: '#/components/parameters/database'
- name: force
in: query
description: Force database to be delete (useful for databases in inconsistent states)
required: false
schema:
type: boolean
default: false
responses:
200:
description: Succesfully deleted DB
content:
application/json:
schema:
type: object
properties:
"@type":
type: string
example: api:DbDeleteResponse
"api:status":
type: string
example: api:success
403:
description: Forbidden
404:
description: Can't find DB
content:
application/json:
schema:
type: object
properties:
"@type":
type: string
example: api:DbDeleteErrorResponse
"api:error":
type: object
properties:
"@type":
type: string
example: api:UnknownDatabase
"api:database_name":
type: string
example: MyNonExistingDatabase
"api:organization_name":
type: string
example: admin
put:
tags:
- database
summary: Change qualities of a database (label, comment, etc.)
parameters:
- $ref: '#/components/parameters/organization'
- $ref: '#/components/parameters/database'
requestBody: # TODO: Missing prefixes
required: true
content:
application/json:
schema:
type: object
properties:
comment:
type: string
example: A sample comment for my database
label:
type: string
example: Testdatabase
public:
type: boolean
example: false
description: Should the database be accessible for all users?
schema:
type: boolean
example: true
description: Should the database be initialized with a schema?
required:
- comment
- label
responses:
200:
description: Updated database
content:
application/json:
schema:
type: object
properties:
"@type":
type: string
example: api:DbUpdatedResponse
"api:status":
type: string
example: api:success
404:
description: Database not found
content:
application/json:
schema:
type: object
properties:
"@type":
type: string
example: api:DbUpdateErrorResponse
"api:error":
type: object
properties:
"@type":
type: string
example: api:UnknownDatabase
"api:database_name":
type: string
example: MyNonExistingDatabase
"api:organization_name":
type: string
example: admin
"api:message":
type: string
example: "Unknown database: admin/MyNonExistingDatabase"
"api:status":
type: string
example: api:not_found
401:
$ref: '#/components/responses/UnauthorizedError'
/document/{path}:
get:
tags:
- document
summary: Get a document
parameters:
- $ref: '#/components/parameters/document_path'
- $ref: '#/components/parameters/graph_type'
- name: skip
in: query
description: Skip a certain amount of documents
required: false
schema:
type: integer
default: 0
- name: count
in: query
description: Number of entries to show
required: false
schema:
type: integer
example: 3
- name: minimized
in: query
description: Minify the output
required: false
schema:
type: boolean
default: true
- name: as_list
in: query
description: Return the JSONs as list instead of concatenated json
required: false
schema:
type: boolean
default: false
- name: unfold
in: query
description: Unfold the documents (join other referenced documents)
schema:
type: boolean
default: true
- name: id
in: query
required: false
description: Specific document ID to look for
schema:
type: string
example: Person_Robin_1991-02-01
- name: type
in: query
required: false
description: Get documents of only a specific type
schema:
type: string
example: Person
- name: compress_ids
in: query
required: false
description: Whether to compress all ids using prefixes
schema:
type: boolean
default: true
responses:
200:
description: List of documents
content:
application/json:
schema:
type: object
description: Concatenated list of JSON documents
example: {"@id":"Organization/admin", "@type":"Organization", "database": ["SystemDatabase/system", "UserDatabase/60c35164e937174bbf4dd814c78153d660edc55b3d799c534c1e2d872a3d2dd6" ], "name":"admin"}
post:
tags:
- document
summary: Insert a new document
parameters:
- $ref: '#/components/parameters/document_path'
- $ref: '#/components/parameters/author'
- $ref: '#/components/parameters/message'
- $ref: '#/components/parameters/graph_type'
- name: full_replace
in: query
required: false
description: Fully replace a document
schema:
type: boolean
default: false
- name: raw_json
in: query
required: false
description: Whether to interpret the posted document as arbitrary untyped JSON
schema:
type: boolean
default: false
responses:
200:
description: Succesfully added documents
content:
application/json:
schema:
type: object
description: Added documents
delete:
tags:
- document
summary: Delete one or multiple documents
parameters:
- $ref: '#/components/parameters/document_path'
- $ref: '#/components/parameters/author'
- $ref: '#/components/parameters/message'
- $ref: '#/components/parameters/graph_type'
- name: nuke
in: query
description: Totally nuke the document(s)
schema:
type: boolean
default: false
- name: id
in: query
description: ID of document(s)
schema:
type: string
example: admin/SomeDocument
responses:
200:
description: Succesfully deleted document(s)
# TODO: Need the proper JSON resposne!
put:
tags:
- document
summary: Replace a document
parameters:
- $ref: '#/components/parameters/document_path'
- $ref: '#/components/parameters/author'
- $ref: '#/components/parameters/message'
- $ref: '#/components/parameters/graph_type'
- name: create
in: query
description: Create a document if it does not exist
required: false
schema:
type: boolean
default: false
- name: raw_json
in: query
description: Treat incoming document as raw json (not type checked)
required: false
schema:
type: boolean
default: false
responses:
200:
description: Succesfully replaced documents
/schema:
get:
tags:
- frame
summary: Get the full class frame for a class or all classes for a schema
parameters:
- $ref: '#/components/parameters/document_path'
- name: compress_ids
in: query
description: Compress the URLs returned using prefixes
required: false
schema:
type: boolean
default: true
- name: expand_abstract
in: query
description: Whether to expand abstract classes into lists of concrete classes in frame options
required: false
schema:
type: boolean
default: true
responses:
200:
description: Class Frame, or object of all class frames has been successfully returned
content:
application/json:
schema:
type: object
examples:
OneClass:
value: { "@documentation": { "@comment":"A normal user database.","@properties": { "comment":"A comment associated with the database.", "creation_date":"The time of creation of the database.", "label":"The label name of the database.", "state":"The system transaction state of the database."} }, "@key": {"@type":"Random"}, "@type":"Class", "comment":"xsd:string", "creation_date":"xsd:dateTime","label":"xsd:string","name":"xsd:string","state": {"@id":"DatabaseState","@type":"Enum","@values": ["creating", "deleting", "finalized" ]}}
AllClasses:
value: { "@context": { "@base":"terminusdb:///data/", "@schema":"terminusdb:///schema#", "@type":"Context" }, "Person": {"@type":"Class", "name":"xsd:string"}, "Room": {"@type":"Class", "room_number":"xsd:integer"} }
/woql:
post:
tags:
- WOQL
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WoqlQuery'
responses:
200:
description: Query result
/woql/{path}:
post:
tags:
- WOQL
parameters:
- name: path
description: Database Path
in: path
required: true
schema:
type: string
example: admin/foo
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WoqlQuery'
responses:
200:
description: Query result
/clone/{organization}/{database}:
post:
tags:
- collaboration
parameters:
- $ref: '#/components/parameters/organization'
- $ref: '#/components/parameters/database'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- comment
- label
- remote_url
properties:
comment:
type: string
example: This is a comment on my cloned database
description: The comment to use in the cloned database
label:
type: string
example: This is how I label my cloned database
description: The label to use for the cloned database
remote_url:
type: string
example: 'http://cloud.terminusdb.com/TerminatorsX/TerminatorsX/nuclear'
description: The URL of the database to clone
public:
type: boolean
description: Whether to make the newly cloned database public
responses:
200:
description: Database cloned succesfully
content:
application/json:
schema:
type: object
/fetch/{path}:
post:
tags:
- collaboration
summary: Fetch the remote repository for the given path (default is origin)
parameters:
- $ref: '#/components/parameters/branch_path'
- name: AUTHORIZATION_REMOTE
in: header
required: true
description: The authorization to use on the remote
schema:
type: string
example: Basic S2FybEthdXRza3k6cGFzc3dvcmRfZGVzdGluYXRpb24=
responses:
200:
description: "Successful fetch"
content:
application/json:
schema:
type: object
properties:
"@type:":
type: string
enum:
- "api:FetchRequest"
"api:status":
type: string
enum:
- "api:success"
"api:head_has_changed":
type: boolean
"api:head":
type: string
example: 194822f8942286517e151817d38acca4c9ac7d01
/push/{path}:
post:
summary: Push the branch to the remote
tags:
- collaboration
parameters:
- $ref: '#/components/parameters/branch_path'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- remote
- remote_branch
properties:
remote:
type: string
example: origin
description: The name of the remote to push to
remote_branch:
type: string
example: main
description: The name of the branch on the remote to push
push_prefixes:
type: boolean
default: false
description: Should the prefixes also be pushed to the remote?
responses:
200:
description: "Push Response"
content:
application/json:
schema:
type: object
properties:
"@type":
type: string
enum:
- "api:PushResponse"
"api:repo_head_updated":
type: boolean
"api:repo_head":
type: string
example: 194822f8942286517e151817d38acca4c9ac7d01
"api:status":
type: string
enum:
- "api:success"
400:
description: "Push Response"
content:
application/json:
schema:
type: object
properties:
"@type":
type: string
enum:
- "api:PushErrorResponse"
"api:error":
type: object
"api:message":
type: string
example: "Unknown remote repository: porridgen"
"api:status":
type: string
enum:
- "api:failure"
/pull/{path}:
post:
summary: Pull to a branch from a remote
tags:
- collaboration
parameters:
- $ref: '#/components/parameters/branch_path'
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- remote
- remote_branch
properties:
remote:
type: string
example: origin
description: The name of the remote to push to
remote_branch:
type: string
example: main
description: The name of the branch on the remote to push
responses:
200:
description: "Pull Response"
content:
application/json:
schema:
type: object
properties:
"@type":
type: string
enum:
- "api:PullResponse"
"api:status":
type: string
enum:
- "api:success"
/branch/{path}:
post:
tags:
- branches
parameters:
- $ref: '#/components/parameters/branch_path'
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
200:
description: "Branch succesfully added"
content:
application/json:
schema:
type: object
properties:
"@type:":
type: string
enum:
- "api:BranchResponse"
"api:status":
type: string
enum:
- "api:success"
delete:
tags:
- branches
parameters:
- $ref: '#/components/parameters/branch_path'
responses:
200:
description: "Branch succesfully deleted"
content:
application/json:
schema:
type: object
properties:
"@type:":
type: string
enum:
- "api:BranchResponse"
"api:status":
type: string
enum:
- "api:success"
/squash/{path}:
parameters:
- $ref: '#/components/parameters/branch_path'
get:
tags:
- branches
responses:
200:
description: "Succesfully squashed the branch"
content:
application/json:
schema:
type: object
properties:
"@type":
type: string
enum:
- "api:SquashResponse"
"api:commit":
type: string
example: admin/test/local/commit/apgatilsa03g4lsa9ra5698wom5wcv7
"api:old_commit":
type: string
example: admin/test/local/commit/5jndjh9lexe62q9u1q2vofyjemfnmyt
"api:status":
type: string
enum:
- api:success
/reset/{path}:
parameters:
- $ref: '#/components/parameters/branch_path'
post:
tags:
- branches
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
commit_descriptor:
type: string
example: admin/test/local/commit/5jndjh9lexe62q9u1q2vofyjemfnmyt
responses:
200:
description: "Succesfully reset branch HEAD to commit_descriptor"
content:
application/json:
schema:
type: object
properties:
"@type":
type: string
enum:
- api:ResetResponse
"api:status":
type: string
enum:
- api:success
/optimize/{path}:
post:
tags:
- database
parameters:
- name: path
description: Database Path
in: path
required: true
schema:
type: string
example: _system
responses:
200:
description: Succesfully optimized resource
content:
application/json:
schema:
type: object
properties:
"@type":
type: string
enum:
- api:OptimizeResponse
"api:status":
type: string
enum:
- api:success
/prefixes/{path}:
get:
tags:
- prefixes
parameters:
- name: path
description: Database Path
in: path
required: true
schema:
type: string
example: _system
responses:
200:
description: "Succesfully fetched prefixes of graph"
content:
application/json:
schema:
type: object
/diff:
post:
tags:
- change management
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
"before":
type: object
example: { "@id" : "Person/Jane", "@type" : "Person", "name" : "Jane"}
"after":
type: object
example: { "@id" : "Person/Jane", "@type" : "Person", "name" : "Jannet"}
"keep":
type: object
example: { "@id" : true, "_id" : true }
responses:
200:
description: "Successful Diff"
content:
application/json:
schema:
type: object
example: { "name" : { "@op" : "ValueSwap", "@before" : "Jane", "@after": "Janine" }}
404:
description: "Failed to find diff"
/patch:
post:
tags:
- change management
requestBody:
required: true
content:
application/json:
schema:
type: object