@centia-io/mcp-server 1.0.1 → 1.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/centia-api.json +220 -149
- package/package.json +1 -1
package/centia-api.json
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
"tags": [
|
|
14
14
|
"Methods"
|
|
15
15
|
],
|
|
16
|
-
"description": "Call a RPC method",
|
|
16
|
+
"description": "Call a JSON-RPC method with or without parameters. The method must be defined in the database. See /api/v4/methods (postRpc) ",
|
|
17
17
|
"operationId": "postCall",
|
|
18
18
|
"requestBody": {
|
|
19
19
|
"description": "RPC method call",
|
|
@@ -28,9 +28,44 @@
|
|
|
28
28
|
},
|
|
29
29
|
"responses": {
|
|
30
30
|
"200": {
|
|
31
|
-
"description": "
|
|
31
|
+
"description": "Ok",
|
|
32
32
|
"content": {
|
|
33
|
-
"application/json": {}
|
|
33
|
+
"application/json": {},
|
|
34
|
+
"application/gpx": {},
|
|
35
|
+
"application/octet-stream": {}
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
"400": {
|
|
39
|
+
"description": "Bad request"
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
}
|
|
43
|
+
},
|
|
44
|
+
"/api/v4/call/dry": {
|
|
45
|
+
"post": {
|
|
46
|
+
"tags": [
|
|
47
|
+
"Methods"
|
|
48
|
+
],
|
|
49
|
+
"description": "Dry run the RPC-JSON call to infer the types and store them. \n Types are only inferred and stored when dry running calls. Dry runs doesn't make effects on the database.\n Dry-run before getting TypeScript types from /api/v4/interfaces (getTypeScript)",
|
|
50
|
+
"operationId": "postCallDry",
|
|
51
|
+
"requestBody": {
|
|
52
|
+
"description": "RPC method call",
|
|
53
|
+
"required": true,
|
|
54
|
+
"content": {
|
|
55
|
+
"application/json": {
|
|
56
|
+
"schema": {
|
|
57
|
+
"$ref": "#/components/schemas/Call"
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
}
|
|
61
|
+
},
|
|
62
|
+
"responses": {
|
|
63
|
+
"200": {
|
|
64
|
+
"description": "Ok",
|
|
65
|
+
"content": {
|
|
66
|
+
"application/json": {},
|
|
67
|
+
"application/gpx": {},
|
|
68
|
+
"application/octet-stream": {}
|
|
34
69
|
}
|
|
35
70
|
},
|
|
36
71
|
"400": {
|
|
@@ -44,7 +79,7 @@
|
|
|
44
79
|
"tags": [
|
|
45
80
|
"Clients"
|
|
46
81
|
],
|
|
47
|
-
"description": "Get client",
|
|
82
|
+
"description": "Get OAuth client(s).",
|
|
48
83
|
"operationId": "getClient",
|
|
49
84
|
"parameters": [
|
|
50
85
|
{
|
|
@@ -89,7 +124,7 @@
|
|
|
89
124
|
"tags": [
|
|
90
125
|
"Clients"
|
|
91
126
|
],
|
|
92
|
-
"description": "Delete client",
|
|
127
|
+
"description": "Delete OAuth client(s).",
|
|
93
128
|
"operationId": "deleteClient",
|
|
94
129
|
"parameters": [
|
|
95
130
|
{
|
|
@@ -113,7 +148,7 @@
|
|
|
113
148
|
"tags": [
|
|
114
149
|
"Clients"
|
|
115
150
|
],
|
|
116
|
-
"description": "Update client",
|
|
151
|
+
"description": "Update existing OAuth client(s).",
|
|
117
152
|
"operationId": "patchClient",
|
|
118
153
|
"parameters": [
|
|
119
154
|
{
|
|
@@ -153,7 +188,7 @@
|
|
|
153
188
|
"tags": [
|
|
154
189
|
"Clients"
|
|
155
190
|
],
|
|
156
|
-
"description": "Create
|
|
191
|
+
"description": "Create new OAuth client(s).",
|
|
157
192
|
"operationId": "postClient",
|
|
158
193
|
"requestBody": {
|
|
159
194
|
"description": "New client",
|
|
@@ -287,7 +322,7 @@
|
|
|
287
322
|
"tags": [
|
|
288
323
|
"Schema"
|
|
289
324
|
],
|
|
290
|
-
"description": "Create new column(s)",
|
|
325
|
+
"description": "Create new column(s).",
|
|
291
326
|
"operationId": "postColumn",
|
|
292
327
|
"parameters": [
|
|
293
328
|
{
|
|
@@ -334,7 +369,7 @@
|
|
|
334
369
|
"tags": [
|
|
335
370
|
"Schema"
|
|
336
371
|
],
|
|
337
|
-
"description": "Update column(s)",
|
|
372
|
+
"description": "Update existing column(s)",
|
|
338
373
|
"operationId": "patchColumn",
|
|
339
374
|
"parameters": [
|
|
340
375
|
{
|
|
@@ -416,7 +451,7 @@
|
|
|
416
451
|
"tags": [
|
|
417
452
|
"Schema"
|
|
418
453
|
],
|
|
419
|
-
"description": "Get
|
|
454
|
+
"description": "Get constraint(s).",
|
|
420
455
|
"operationId": "getConstraint",
|
|
421
456
|
"parameters": [
|
|
422
457
|
{
|
|
@@ -457,12 +492,12 @@
|
|
|
457
492
|
}
|
|
458
493
|
}
|
|
459
494
|
},
|
|
460
|
-
"
|
|
495
|
+
"delete": {
|
|
461
496
|
"tags": [
|
|
462
497
|
"Schema"
|
|
463
498
|
],
|
|
464
|
-
"description": "
|
|
465
|
-
"operationId": "
|
|
499
|
+
"description": "Delete constraint(s)",
|
|
500
|
+
"operationId": "deleteConstraint",
|
|
466
501
|
"parameters": [
|
|
467
502
|
{
|
|
468
503
|
"name": "schema",
|
|
@@ -477,31 +512,32 @@
|
|
|
477
512
|
"description": "Table name",
|
|
478
513
|
"required": true,
|
|
479
514
|
"example": "my_table"
|
|
515
|
+
},
|
|
516
|
+
{
|
|
517
|
+
"name": "constraint",
|
|
518
|
+
"in": "path",
|
|
519
|
+
"description": "Constraint name(s)",
|
|
520
|
+
"required": true,
|
|
521
|
+
"example": "my_constraint"
|
|
480
522
|
}
|
|
481
523
|
],
|
|
482
|
-
"requestBody": {
|
|
483
|
-
"description": "New constraint",
|
|
484
|
-
"required": true,
|
|
485
|
-
"content": {
|
|
486
|
-
"application/json": {
|
|
487
|
-
"schema": {
|
|
488
|
-
"$ref": "#/components/schemas/Constraint"
|
|
489
|
-
}
|
|
490
|
-
}
|
|
491
|
-
}
|
|
492
|
-
},
|
|
493
524
|
"responses": {
|
|
494
|
-
"
|
|
495
|
-
"description": "
|
|
525
|
+
"204": {
|
|
526
|
+
"description": "Column deleted"
|
|
527
|
+
},
|
|
528
|
+
"404": {
|
|
529
|
+
"description": "Not found"
|
|
496
530
|
}
|
|
497
531
|
}
|
|
498
|
-
}
|
|
499
|
-
|
|
532
|
+
}
|
|
533
|
+
},
|
|
534
|
+
"/api/v4/schemas/{schema}/tables/{table}/constraints": {
|
|
535
|
+
"post": {
|
|
500
536
|
"tags": [
|
|
501
537
|
"Schema"
|
|
502
538
|
],
|
|
503
|
-
"description": "
|
|
504
|
-
"operationId": "
|
|
539
|
+
"description": "Create constraint(s).",
|
|
540
|
+
"operationId": "postConstraint",
|
|
505
541
|
"parameters": [
|
|
506
542
|
{
|
|
507
543
|
"name": "schema",
|
|
@@ -516,21 +552,22 @@
|
|
|
516
552
|
"description": "Table name",
|
|
517
553
|
"required": true,
|
|
518
554
|
"example": "my_table"
|
|
519
|
-
},
|
|
520
|
-
{
|
|
521
|
-
"name": "constraint",
|
|
522
|
-
"in": "path",
|
|
523
|
-
"description": "Constraint name(s)",
|
|
524
|
-
"required": true,
|
|
525
|
-
"example": "my_constraint"
|
|
526
555
|
}
|
|
527
556
|
],
|
|
557
|
+
"requestBody": {
|
|
558
|
+
"description": "New constraint",
|
|
559
|
+
"required": true,
|
|
560
|
+
"content": {
|
|
561
|
+
"application/json": {
|
|
562
|
+
"schema": {
|
|
563
|
+
"$ref": "#/components/schemas/Constraint"
|
|
564
|
+
}
|
|
565
|
+
}
|
|
566
|
+
}
|
|
567
|
+
},
|
|
528
568
|
"responses": {
|
|
529
|
-
"
|
|
530
|
-
"description": "
|
|
531
|
-
},
|
|
532
|
-
"404": {
|
|
533
|
-
"description": "Not found"
|
|
569
|
+
"201": {
|
|
570
|
+
"description": "Created"
|
|
534
571
|
}
|
|
535
572
|
}
|
|
536
573
|
}
|
|
@@ -598,7 +635,7 @@
|
|
|
598
635
|
"tags": [
|
|
599
636
|
"Rules"
|
|
600
637
|
],
|
|
601
|
-
"description": "Get rule(s)",
|
|
638
|
+
"description": "Get rule(s).",
|
|
602
639
|
"operationId": "getRule",
|
|
603
640
|
"parameters": [
|
|
604
641
|
{
|
|
@@ -629,7 +666,7 @@
|
|
|
629
666
|
"tags": [
|
|
630
667
|
"Rules"
|
|
631
668
|
],
|
|
632
|
-
"description": "Delete rule(s)",
|
|
669
|
+
"description": "Delete rule(s).",
|
|
633
670
|
"operationId": "deleteRule",
|
|
634
671
|
"parameters": [
|
|
635
672
|
{
|
|
@@ -653,7 +690,7 @@
|
|
|
653
690
|
"tags": [
|
|
654
691
|
"Rules"
|
|
655
692
|
],
|
|
656
|
-
"description": "Update rule(s)",
|
|
693
|
+
"description": "Update existing rule(s).",
|
|
657
694
|
"operationId": "patchRule",
|
|
658
695
|
"parameters": [
|
|
659
696
|
{
|
|
@@ -693,7 +730,7 @@
|
|
|
693
730
|
"tags": [
|
|
694
731
|
"Rules"
|
|
695
732
|
],
|
|
696
|
-
"description": "Create rule(s)",
|
|
733
|
+
"description": "Create rule(s).",
|
|
697
734
|
"operationId": "postRule",
|
|
698
735
|
"requestBody": {
|
|
699
736
|
"description": "New rule",
|
|
@@ -765,7 +802,7 @@
|
|
|
765
802
|
"tags": [
|
|
766
803
|
"Schema"
|
|
767
804
|
],
|
|
768
|
-
"description": "Get index(s)",
|
|
805
|
+
"description": "Get index(s).",
|
|
769
806
|
"operationId": "getIndex",
|
|
770
807
|
"parameters": [
|
|
771
808
|
{
|
|
@@ -870,7 +907,7 @@
|
|
|
870
907
|
"tags": [
|
|
871
908
|
"Schema"
|
|
872
909
|
],
|
|
873
|
-
"description": "Create index(s)",
|
|
910
|
+
"description": "Create index(s).",
|
|
874
911
|
"operationId": "postIndex",
|
|
875
912
|
"parameters": [
|
|
876
913
|
{
|
|
@@ -925,7 +962,7 @@
|
|
|
925
962
|
"tags": [
|
|
926
963
|
"Methods"
|
|
927
964
|
],
|
|
928
|
-
"description": "Get JSON-RPC method
|
|
965
|
+
"description": "Get JSON-RPC method definitions.",
|
|
929
966
|
"operationId": "getRpc",
|
|
930
967
|
"parameters": [
|
|
931
968
|
{
|
|
@@ -952,11 +989,35 @@
|
|
|
952
989
|
}
|
|
953
990
|
}
|
|
954
991
|
},
|
|
992
|
+
"delete": {
|
|
993
|
+
"tags": [
|
|
994
|
+
"Methods"
|
|
995
|
+
],
|
|
996
|
+
"description": "Delete JSON-RPC method(s).",
|
|
997
|
+
"operationId": "deleteRpc",
|
|
998
|
+
"parameters": [
|
|
999
|
+
{
|
|
1000
|
+
"name": "method",
|
|
1001
|
+
"in": "path",
|
|
1002
|
+
"description": "Name of method",
|
|
1003
|
+
"required": true,
|
|
1004
|
+
"example": "myStatement"
|
|
1005
|
+
}
|
|
1006
|
+
],
|
|
1007
|
+
"responses": {
|
|
1008
|
+
"204": {
|
|
1009
|
+
"description": "Method deleted"
|
|
1010
|
+
},
|
|
1011
|
+
"404": {
|
|
1012
|
+
"description": "Not found"
|
|
1013
|
+
}
|
|
1014
|
+
}
|
|
1015
|
+
},
|
|
955
1016
|
"patch": {
|
|
956
1017
|
"tags": [
|
|
957
1018
|
"Methods"
|
|
958
1019
|
],
|
|
959
|
-
"description": "Update JSON-RPC method(s)",
|
|
1020
|
+
"description": "Update existing JSON-RPC method(s).",
|
|
960
1021
|
"operationId": "patchRpc",
|
|
961
1022
|
"parameters": [
|
|
962
1023
|
{
|
|
@@ -996,7 +1057,7 @@
|
|
|
996
1057
|
"tags": [
|
|
997
1058
|
"Methods"
|
|
998
1059
|
],
|
|
999
|
-
"description": "Create JSON-RPC method(s)",
|
|
1060
|
+
"description": "Create JSON-RPC method(s). This means you define a named method which holds your SQL query along with optional instructions on how to interpret and format the data types.",
|
|
1000
1061
|
"operationId": "postRpc",
|
|
1001
1062
|
"requestBody": {
|
|
1002
1063
|
"description": "RPC method to create",
|
|
@@ -1022,32 +1083,6 @@
|
|
|
1022
1083
|
}
|
|
1023
1084
|
}
|
|
1024
1085
|
},
|
|
1025
|
-
"/api/v4/methods/{id}": {
|
|
1026
|
-
"delete": {
|
|
1027
|
-
"tags": [
|
|
1028
|
-
"Methods"
|
|
1029
|
-
],
|
|
1030
|
-
"description": "Delete JSON-RPC method(s)",
|
|
1031
|
-
"operationId": "deleteRpc",
|
|
1032
|
-
"parameters": [
|
|
1033
|
-
{
|
|
1034
|
-
"name": "id",
|
|
1035
|
-
"in": "path",
|
|
1036
|
-
"description": "Name of method",
|
|
1037
|
-
"required": true,
|
|
1038
|
-
"example": "myStatement"
|
|
1039
|
-
}
|
|
1040
|
-
],
|
|
1041
|
-
"responses": {
|
|
1042
|
-
"204": {
|
|
1043
|
-
"description": "Method deleted"
|
|
1044
|
-
},
|
|
1045
|
-
"404": {
|
|
1046
|
-
"description": "Not found"
|
|
1047
|
-
}
|
|
1048
|
-
}
|
|
1049
|
-
}
|
|
1050
|
-
},
|
|
1051
1086
|
"/api/v4/oauth": {
|
|
1052
1087
|
"post": {
|
|
1053
1088
|
"tags": [
|
|
@@ -1123,7 +1158,7 @@
|
|
|
1123
1158
|
"tags": [
|
|
1124
1159
|
"Privileges"
|
|
1125
1160
|
],
|
|
1126
|
-
"description": "Get privileges",
|
|
1161
|
+
"description": "Get privileges.",
|
|
1127
1162
|
"operationId": "getPrivileges",
|
|
1128
1163
|
"parameters": [
|
|
1129
1164
|
{
|
|
@@ -1161,7 +1196,7 @@
|
|
|
1161
1196
|
"tags": [
|
|
1162
1197
|
"Privileges"
|
|
1163
1198
|
],
|
|
1164
|
-
"description": "Update privileges",
|
|
1199
|
+
"description": "Update privileges.",
|
|
1165
1200
|
"operationId": "patchPrivileges",
|
|
1166
1201
|
"parameters": [
|
|
1167
1202
|
{
|
|
@@ -1208,7 +1243,7 @@
|
|
|
1208
1243
|
"tags": [
|
|
1209
1244
|
"Methods"
|
|
1210
1245
|
],
|
|
1211
|
-
"description": "Get the interfaces for all RPC-JSON methods.",
|
|
1246
|
+
"description": "Get the interfaces for all RPC-JSON methods. Returns TypeScript interfaces inferred from dry-runs via /api/v4/call/dry (postCallDry)",
|
|
1212
1247
|
"operationId": "getTypeScript",
|
|
1213
1248
|
"responses": {
|
|
1214
1249
|
"200": {
|
|
@@ -1225,7 +1260,7 @@
|
|
|
1225
1260
|
"tags": [
|
|
1226
1261
|
"Schema"
|
|
1227
1262
|
],
|
|
1228
|
-
"description": "Get schema(s)",
|
|
1263
|
+
"description": "Get schema(s).",
|
|
1229
1264
|
"operationId": "getSchema",
|
|
1230
1265
|
"parameters": [
|
|
1231
1266
|
{
|
|
@@ -1268,7 +1303,7 @@
|
|
|
1268
1303
|
"tags": [
|
|
1269
1304
|
"Schema"
|
|
1270
1305
|
],
|
|
1271
|
-
"description": "Delete schema(s)",
|
|
1306
|
+
"description": "Delete schema(s).",
|
|
1272
1307
|
"operationId": "deleteSchema",
|
|
1273
1308
|
"parameters": [
|
|
1274
1309
|
{
|
|
@@ -1295,7 +1330,7 @@
|
|
|
1295
1330
|
"tags": [
|
|
1296
1331
|
"Schema"
|
|
1297
1332
|
],
|
|
1298
|
-
"description": "Rename
|
|
1333
|
+
"description": "Rename an existing schema.",
|
|
1299
1334
|
"operationId": "patchSchema",
|
|
1300
1335
|
"parameters": [
|
|
1301
1336
|
{
|
|
@@ -1349,7 +1384,7 @@
|
|
|
1349
1384
|
"tags": [
|
|
1350
1385
|
"Schema"
|
|
1351
1386
|
],
|
|
1352
|
-
"description": "Create schema(s)",
|
|
1387
|
+
"description": "Create schema(s).",
|
|
1353
1388
|
"operationId": "postSchema",
|
|
1354
1389
|
"requestBody": {
|
|
1355
1390
|
"description": "New schema",
|
|
@@ -1377,7 +1412,7 @@
|
|
|
1377
1412
|
"tags": [
|
|
1378
1413
|
"Schema"
|
|
1379
1414
|
],
|
|
1380
|
-
"description": "Get sequence(s)",
|
|
1415
|
+
"description": "Get sequence(s).",
|
|
1381
1416
|
"operationId": "getSequence",
|
|
1382
1417
|
"parameters": [
|
|
1383
1418
|
{
|
|
@@ -1415,7 +1450,7 @@
|
|
|
1415
1450
|
"tags": [
|
|
1416
1451
|
"Schema"
|
|
1417
1452
|
],
|
|
1418
|
-
"description": "Delete sequence(s)",
|
|
1453
|
+
"description": "Delete sequence(s).",
|
|
1419
1454
|
"operationId": "deleteSequence",
|
|
1420
1455
|
"parameters": [
|
|
1421
1456
|
{
|
|
@@ -1446,7 +1481,7 @@
|
|
|
1446
1481
|
"tags": [
|
|
1447
1482
|
"Schema"
|
|
1448
1483
|
],
|
|
1449
|
-
"description": "Update sequence(s)",
|
|
1484
|
+
"description": "Update existing sequence(s).",
|
|
1450
1485
|
"operationId": "patchSequence",
|
|
1451
1486
|
"parameters": [
|
|
1452
1487
|
{
|
|
@@ -1493,7 +1528,7 @@
|
|
|
1493
1528
|
"tags": [
|
|
1494
1529
|
"Schema"
|
|
1495
1530
|
],
|
|
1496
|
-
"description": "Create sequence(s)",
|
|
1531
|
+
"description": "Create sequence(s).",
|
|
1497
1532
|
"operationId": "postSequence",
|
|
1498
1533
|
"parameters": [
|
|
1499
1534
|
{
|
|
@@ -1550,11 +1585,13 @@
|
|
|
1550
1585
|
"200": {
|
|
1551
1586
|
"description": "Ok",
|
|
1552
1587
|
"content": {
|
|
1553
|
-
"application/json": {}
|
|
1588
|
+
"application/json": {},
|
|
1589
|
+
"application/gpx": {},
|
|
1590
|
+
"application/octet-stream": {}
|
|
1554
1591
|
}
|
|
1555
1592
|
},
|
|
1556
1593
|
"500": {
|
|
1557
|
-
"description": "Internal error. Most
|
|
1594
|
+
"description": "Internal error. Most likely an SQL error."
|
|
1558
1595
|
}
|
|
1559
1596
|
}
|
|
1560
1597
|
}
|
|
@@ -1628,7 +1665,7 @@
|
|
|
1628
1665
|
"tags": [
|
|
1629
1666
|
"Schema"
|
|
1630
1667
|
],
|
|
1631
|
-
"description": "Get table(s)",
|
|
1668
|
+
"description": "Get table(s).",
|
|
1632
1669
|
"operationId": "getTable",
|
|
1633
1670
|
"parameters": [
|
|
1634
1671
|
{
|
|
@@ -1703,7 +1740,7 @@
|
|
|
1703
1740
|
"tags": [
|
|
1704
1741
|
"Schema"
|
|
1705
1742
|
],
|
|
1706
|
-
"description": "Delete table",
|
|
1743
|
+
"description": "Delete table(s).",
|
|
1707
1744
|
"operationId": "deleteTable",
|
|
1708
1745
|
"parameters": [
|
|
1709
1746
|
{
|
|
@@ -1737,7 +1774,7 @@
|
|
|
1737
1774
|
"tags": [
|
|
1738
1775
|
"Schema"
|
|
1739
1776
|
],
|
|
1740
|
-
"description": "Rename and move table(s)",
|
|
1777
|
+
"description": "Rename and move existing table(s).",
|
|
1741
1778
|
"operationId": "patchTable",
|
|
1742
1779
|
"parameters": [
|
|
1743
1780
|
{
|
|
@@ -1773,6 +1810,12 @@
|
|
|
1773
1810
|
"description": "Move table to schema",
|
|
1774
1811
|
"type": "string",
|
|
1775
1812
|
"example": "my_other_schema"
|
|
1813
|
+
},
|
|
1814
|
+
"comment": {
|
|
1815
|
+
"title": "Comment",
|
|
1816
|
+
"description": "Comment on the table",
|
|
1817
|
+
"type": "string",
|
|
1818
|
+
"example": "This is a comment on the table"
|
|
1776
1819
|
}
|
|
1777
1820
|
},
|
|
1778
1821
|
"type": "object"
|
|
@@ -1800,7 +1843,7 @@
|
|
|
1800
1843
|
"tags": [
|
|
1801
1844
|
"Schema"
|
|
1802
1845
|
],
|
|
1803
|
-
"description": "Create table(s)",
|
|
1846
|
+
"description": "Create table(s).",
|
|
1804
1847
|
"operationId": "postTable",
|
|
1805
1848
|
"parameters": [
|
|
1806
1849
|
{
|
|
@@ -1832,12 +1875,12 @@
|
|
|
1832
1875
|
}
|
|
1833
1876
|
}
|
|
1834
1877
|
},
|
|
1835
|
-
"/api/v4/
|
|
1878
|
+
"/api/v4/users/{name}": {
|
|
1836
1879
|
"get": {
|
|
1837
1880
|
"tags": [
|
|
1838
1881
|
"Users"
|
|
1839
1882
|
],
|
|
1840
|
-
"description": "Get
|
|
1883
|
+
"description": "Get sub-user(s)",
|
|
1841
1884
|
"operationId": "getUser",
|
|
1842
1885
|
"parameters": [
|
|
1843
1886
|
{
|
|
@@ -1863,45 +1906,12 @@
|
|
|
1863
1906
|
"description": "Not found"
|
|
1864
1907
|
}
|
|
1865
1908
|
}
|
|
1866
|
-
}
|
|
1867
|
-
},
|
|
1868
|
-
"/api/v4/users": {
|
|
1869
|
-
"post": {
|
|
1870
|
-
"tags": [
|
|
1871
|
-
"Users"
|
|
1872
|
-
],
|
|
1873
|
-
"description": "New user",
|
|
1874
|
-
"operationId": "postUser",
|
|
1875
|
-
"requestBody": {
|
|
1876
|
-
"description": "New user",
|
|
1877
|
-
"required": true,
|
|
1878
|
-
"content": {
|
|
1879
|
-
"application/json": {
|
|
1880
|
-
"schema": {
|
|
1881
|
-
"$ref": "#/components/schemas/User"
|
|
1882
|
-
}
|
|
1883
|
-
}
|
|
1884
|
-
}
|
|
1885
|
-
},
|
|
1886
|
-
"responses": {
|
|
1887
|
-
"201": {
|
|
1888
|
-
"description": "Created"
|
|
1889
|
-
},
|
|
1890
|
-
"400": {
|
|
1891
|
-
"description": "Bad request"
|
|
1892
|
-
},
|
|
1893
|
-
"404": {
|
|
1894
|
-
"description": "Not found"
|
|
1895
|
-
}
|
|
1896
|
-
}
|
|
1897
|
-
}
|
|
1898
|
-
},
|
|
1899
|
-
"/api/v4/users/{name}": {
|
|
1909
|
+
},
|
|
1900
1910
|
"delete": {
|
|
1901
1911
|
"tags": [
|
|
1902
1912
|
"Users"
|
|
1903
1913
|
],
|
|
1904
|
-
"description": "Delete user",
|
|
1914
|
+
"description": "Delete sub-user(s)",
|
|
1905
1915
|
"operationId": "deleteUsers",
|
|
1906
1916
|
"parameters": [
|
|
1907
1917
|
{
|
|
@@ -1925,7 +1935,7 @@
|
|
|
1925
1935
|
"tags": [
|
|
1926
1936
|
"Users"
|
|
1927
1937
|
],
|
|
1928
|
-
"description": "Update user",
|
|
1938
|
+
"description": "Update exiting sub-user(s)",
|
|
1929
1939
|
"operationId": "patchUser",
|
|
1930
1940
|
"parameters": [
|
|
1931
1941
|
{
|
|
@@ -1959,6 +1969,37 @@
|
|
|
1959
1969
|
}
|
|
1960
1970
|
}
|
|
1961
1971
|
}
|
|
1972
|
+
},
|
|
1973
|
+
"/api/v4/users": {
|
|
1974
|
+
"post": {
|
|
1975
|
+
"tags": [
|
|
1976
|
+
"Users"
|
|
1977
|
+
],
|
|
1978
|
+
"description": "Create new sub-user(s)",
|
|
1979
|
+
"operationId": "postUser",
|
|
1980
|
+
"requestBody": {
|
|
1981
|
+
"description": "New user",
|
|
1982
|
+
"required": true,
|
|
1983
|
+
"content": {
|
|
1984
|
+
"application/json": {
|
|
1985
|
+
"schema": {
|
|
1986
|
+
"$ref": "#/components/schemas/User"
|
|
1987
|
+
}
|
|
1988
|
+
}
|
|
1989
|
+
}
|
|
1990
|
+
},
|
|
1991
|
+
"responses": {
|
|
1992
|
+
"201": {
|
|
1993
|
+
"description": "Created"
|
|
1994
|
+
},
|
|
1995
|
+
"400": {
|
|
1996
|
+
"description": "Bad request"
|
|
1997
|
+
},
|
|
1998
|
+
"404": {
|
|
1999
|
+
"description": "Not found"
|
|
2000
|
+
}
|
|
2001
|
+
}
|
|
2002
|
+
}
|
|
1962
2003
|
}
|
|
1963
2004
|
},
|
|
1964
2005
|
"components": {
|
|
@@ -1981,13 +2022,13 @@
|
|
|
1981
2022
|
},
|
|
1982
2023
|
"id": {
|
|
1983
2024
|
"title": "Identifier",
|
|
1984
|
-
"description": "An identifier established by the Client that MUST contain a string if included",
|
|
2025
|
+
"description": "An identifier established by the Client that MUST contain a string if included.",
|
|
1985
2026
|
"type": "string",
|
|
1986
2027
|
"example": "1"
|
|
1987
2028
|
},
|
|
1988
2029
|
"method": {
|
|
1989
2030
|
"title": "Method name",
|
|
1990
|
-
"description": "A String containing the name of the method to be invoked or created",
|
|
2031
|
+
"description": "A String containing the name of the method to be invoked or created.",
|
|
1991
2032
|
"type": "string",
|
|
1992
2033
|
"example": "getDate"
|
|
1993
2034
|
},
|
|
@@ -1998,9 +2039,14 @@
|
|
|
1998
2039
|
"items": {
|
|
1999
2040
|
"type": "object"
|
|
2000
2041
|
},
|
|
2001
|
-
"example":
|
|
2002
|
-
|
|
2003
|
-
|
|
2042
|
+
"example": [
|
|
2043
|
+
{
|
|
2044
|
+
"my_date": "2011 04 01"
|
|
2045
|
+
},
|
|
2046
|
+
{
|
|
2047
|
+
"my_string": "hello world"
|
|
2048
|
+
}
|
|
2049
|
+
]
|
|
2004
2050
|
}
|
|
2005
2051
|
},
|
|
2006
2052
|
"type": "object"
|
|
@@ -2102,7 +2148,7 @@
|
|
|
2102
2148
|
},
|
|
2103
2149
|
"type": {
|
|
2104
2150
|
"title": "Type",
|
|
2105
|
-
"description": "The type of the column, like varchar, integer, boolean etc.",
|
|
2151
|
+
"description": "The type of the column, like varchar, integer, boolean etc. Array types are denoted by adding [] to the type, e.g. varchar[].",
|
|
2106
2152
|
"type": "string",
|
|
2107
2153
|
"example": "int"
|
|
2108
2154
|
},
|
|
@@ -2128,6 +2174,12 @@
|
|
|
2128
2174
|
"by default"
|
|
2129
2175
|
],
|
|
2130
2176
|
"example": "always"
|
|
2177
|
+
},
|
|
2178
|
+
"comment": {
|
|
2179
|
+
"title": "Comment",
|
|
2180
|
+
"description": "Comment on the column.",
|
|
2181
|
+
"type": "string",
|
|
2182
|
+
"example": "This is a comment on the column"
|
|
2131
2183
|
}
|
|
2132
2184
|
},
|
|
2133
2185
|
"type": "object"
|
|
@@ -2185,7 +2237,13 @@
|
|
|
2185
2237
|
"title": "Type",
|
|
2186
2238
|
"description": "Type of the constraint.",
|
|
2187
2239
|
"type": "string",
|
|
2188
|
-
"
|
|
2240
|
+
"enum": [
|
|
2241
|
+
"primary",
|
|
2242
|
+
"foreign",
|
|
2243
|
+
"unique",
|
|
2244
|
+
"check"
|
|
2245
|
+
],
|
|
2246
|
+
"example": "primary"
|
|
2189
2247
|
},
|
|
2190
2248
|
"columns": {
|
|
2191
2249
|
"title": "Columns",
|
|
@@ -2305,6 +2363,7 @@
|
|
|
2305
2363
|
"type": "object"
|
|
2306
2364
|
},
|
|
2307
2365
|
"Rule": {
|
|
2366
|
+
"description": "Rules can deny or allow access to tables or rewrite the SQL statement by adding a where clause. Rules are not attached to tables but applied to the incoming SQL statement before it actually runs in the database engine.",
|
|
2308
2367
|
"required": [],
|
|
2309
2368
|
"properties": {
|
|
2310
2369
|
"id": {
|
|
@@ -2470,7 +2529,7 @@
|
|
|
2470
2529
|
},
|
|
2471
2530
|
"q": {
|
|
2472
2531
|
"title": "Query",
|
|
2473
|
-
"description": "SQL statement. SELECT, INSERT, UPDATE or
|
|
2532
|
+
"description": "SQL statement. SELECT, INSERT, UPDATE, DELETE or MERGE.",
|
|
2474
2533
|
"type": "string",
|
|
2475
2534
|
"example": "SELECT :my_date::date as my_date"
|
|
2476
2535
|
},
|
|
@@ -2694,9 +2753,9 @@
|
|
|
2694
2753
|
"type": "string",
|
|
2695
2754
|
"example": "joe"
|
|
2696
2755
|
},
|
|
2697
|
-
"
|
|
2698
|
-
"title": "
|
|
2699
|
-
"description": "The
|
|
2756
|
+
"privilege": {
|
|
2757
|
+
"title": "Privilege",
|
|
2758
|
+
"description": "The privilege granted to the sub-user on a table.",
|
|
2700
2759
|
"type": "string",
|
|
2701
2760
|
"enum": [
|
|
2702
2761
|
"none",
|
|
@@ -2810,7 +2869,7 @@
|
|
|
2810
2869
|
"properties": {
|
|
2811
2870
|
"q": {
|
|
2812
2871
|
"title": "Query",
|
|
2813
|
-
"description": "SQL statement. SELECT, INSERT, UPDATE, DELETE or MERGE.",
|
|
2872
|
+
"description": "SQL statement. SELECT, INSERT, UPDATE, DELETE or MERGE. No DDL, transaction control, etc.",
|
|
2814
2873
|
"type": "string",
|
|
2815
2874
|
"example": "SELECT :my_date::date as my_date"
|
|
2816
2875
|
},
|
|
@@ -2821,13 +2880,18 @@
|
|
|
2821
2880
|
"items": {
|
|
2822
2881
|
"type": "object"
|
|
2823
2882
|
},
|
|
2824
|
-
"example":
|
|
2825
|
-
|
|
2826
|
-
|
|
2883
|
+
"example": [
|
|
2884
|
+
{
|
|
2885
|
+
"my_date": "2011 04 01"
|
|
2886
|
+
},
|
|
2887
|
+
{
|
|
2888
|
+
"my_string": "hello world"
|
|
2889
|
+
}
|
|
2890
|
+
]
|
|
2827
2891
|
},
|
|
2828
2892
|
"type_hints": {
|
|
2829
2893
|
"title": "Type hints",
|
|
2830
|
-
"description": "For JSON represented parameters which are not of JSON type.",
|
|
2894
|
+
"description": "For JSON represented parameters which are not of JSON/JSONB type.",
|
|
2831
2895
|
"type": "object",
|
|
2832
2896
|
"example": {
|
|
2833
2897
|
"my_date": "date"
|
|
@@ -2843,7 +2907,7 @@
|
|
|
2843
2907
|
},
|
|
2844
2908
|
"output_format": {
|
|
2845
2909
|
"title": "Output format",
|
|
2846
|
-
"description": "The wanted output format.",
|
|
2910
|
+
"description": "The wanted output format: json, geojson, csv, ccsv ndjson, excel or ogr/[any ogr vector format e.g 'ogr/ESRI Shape']. ccsv and ndjson are streamed instead of returning a whole document or file.",
|
|
2847
2911
|
"type": "string",
|
|
2848
2912
|
"default": "json",
|
|
2849
2913
|
"example": "csv"
|
|
@@ -3004,11 +3068,18 @@
|
|
|
3004
3068
|
"items": {
|
|
3005
3069
|
"$ref": "#/components/schemas/Constraint"
|
|
3006
3070
|
}
|
|
3071
|
+
},
|
|
3072
|
+
"comment": {
|
|
3073
|
+
"title": "Comment",
|
|
3074
|
+
"description": "Comment on the table",
|
|
3075
|
+
"type": "string",
|
|
3076
|
+
"example": "This is a comment on the table"
|
|
3007
3077
|
}
|
|
3008
3078
|
},
|
|
3009
3079
|
"type": "object"
|
|
3010
3080
|
},
|
|
3011
3081
|
"User": {
|
|
3082
|
+
"description": "Sub-users are users for your API. While you can use your super-user for single user projects, it is a good idea to create sub-users for projects involving multiple users, which can be granted different privileges in the database.",
|
|
3012
3083
|
"required": [
|
|
3013
3084
|
"name",
|
|
3014
3085
|
"email",
|