2
2
# https://github.com/google/gnostic/tree/master/apps/protoc-gen-openapi
3
3
openapi : 3.0.3
4
4
info :
5
- title : TigrisDB API
5
+ title : Tigris API
6
6
version : 0.0.1
7
7
paths :
8
8
/api/v1/databases/list :
9
9
post :
10
10
tags :
11
- - TigrisDB
11
+ - Tigris
12
12
description : List returns all the databases.
13
- operationId : TigrisDB_ListDatabases
13
+ operationId : Tigris_ListDatabases
14
14
responses :
15
15
" 200 " :
16
16
description : OK
21
21
/api/v1/databases/{db}/collections/list :
22
22
post :
23
23
tags :
24
- - TigrisDB
24
+ - Tigris
25
25
description : List all collections in the database passed in the request.
26
- operationId : TigrisDB_ListCollections
26
+ operationId : Tigris_ListCollections
27
27
parameters :
28
28
- name : db
29
29
in : path
@@ -47,11 +47,11 @@ paths:
47
47
/api/v1/databases/{db}/collections/{collection}/createOrUpdate :
48
48
post :
49
49
tags :
50
- - TigrisDB
50
+ - Tigris
51
51
description : |-
52
52
Creates a new collection or atomically upgrades the collection to the new schema changes in the database
53
53
passed in the request.
54
- operationId : TigrisDB_CreateOrUpdateCollection
54
+ operationId : Tigris_CreateOrUpdateCollection
55
55
parameters :
56
56
- name : db
57
57
in : path
81
81
/api/v1/databases/{db}/collections/{collection}/describe :
82
82
post :
83
83
tags :
84
- - TigrisDB
84
+ - Tigris
85
85
description : Describe collection describes the information related to collection.
86
- operationId : TigrisDB_DescribeCollection
86
+ operationId : Tigris_DescribeCollection
87
87
parameters :
88
88
- name : db
89
89
in : path
@@ -113,9 +113,9 @@ paths:
113
113
/api/v1/databases/{db}/collections/{collection}/documents/delete :
114
114
delete :
115
115
tags :
116
- - TigrisDB
116
+ - Tigris
117
117
description : Delete a range of documents in the collection using the condition provided in the filter.
118
- operationId : TigrisDB_Delete
118
+ operationId : Tigris_Delete
119
119
parameters :
120
120
- name : db
121
121
in : path
@@ -145,12 +145,12 @@ paths:
145
145
/api/v1/databases/{db}/collections/{collection}/documents/insert :
146
146
post :
147
147
tags :
148
- - TigrisDB
148
+ - Tigris
149
149
description : |-
150
150
Inserts new documents in the collection and returns an AlreadyExists error if any of the documents
151
151
in the request already exists. Insert provides idempotency by returning an error if the document
152
152
already exists. To replace documents, use REPLACE API instead of INSERT.
153
- operationId : TigrisDB_Insert
153
+ operationId : Tigris_Insert
154
154
parameters :
155
155
- name : db
156
156
in : path
@@ -180,9 +180,9 @@ paths:
180
180
/api/v1/databases/{db}/collections/{collection}/documents/read :
181
181
post :
182
182
tags :
183
- - TigrisDB
183
+ - Tigris
184
184
description : Reads range of documents from the collection using the condition in the filter.
185
- operationId : TigrisDB_Read
185
+ operationId : Tigris_Read
186
186
parameters :
187
187
- name : db
188
188
in : path
@@ -212,9 +212,9 @@ paths:
212
212
/api/v1/databases/{db}/collections/{collection}/documents/replace :
213
213
put :
214
214
tags :
215
- - TigrisDB
215
+ - Tigris
216
216
description : Inserts the documents or replaces the existing documents in the collections.
217
- operationId : TigrisDB_Replace
217
+ operationId : Tigris_Replace
218
218
parameters :
219
219
- name : db
220
220
in : path
@@ -244,9 +244,9 @@ paths:
244
244
/api/v1/databases/{db}/collections/{collection}/documents/update :
245
245
put :
246
246
tags :
247
- - TigrisDB
247
+ - Tigris
248
248
description : Update a range of documents in the collection using the condition provided in the filter.
249
- operationId : TigrisDB_Update
249
+ operationId : Tigris_Update
250
250
parameters :
251
251
- name : db
252
252
in : path
@@ -276,9 +276,9 @@ paths:
276
276
/api/v1/databases/{db}/collections/{collection}/drop :
277
277
delete :
278
278
tags :
279
- - TigrisDB
279
+ - Tigris
280
280
description : Drop the collection and all its documents in the database passed in the request.
281
- operationId : TigrisDB_DropCollection
281
+ operationId : Tigris_DropCollection
282
282
parameters :
283
283
- name : db
284
284
in : path
@@ -308,9 +308,9 @@ paths:
308
308
/api/v1/databases/{db}/create :
309
309
post :
310
310
tags :
311
- - TigrisDB
311
+ - Tigris
312
312
description : Creates a new database and returns a AlreadyExists error if the database already exists.
313
- operationId : TigrisDB_CreateDatabase
313
+ operationId : Tigris_CreateDatabase
314
314
parameters :
315
315
- name : db
316
316
in : path
@@ -334,11 +334,11 @@ paths:
334
334
/api/v1/databases/{db}/describe :
335
335
post :
336
336
tags :
337
- - TigrisDB
337
+ - Tigris
338
338
description : |-
339
339
Describe database describes the information related to database along
340
340
with all the collections inside database.
341
- operationId : TigrisDB_DescribeDatabase
341
+ operationId : Tigris_DescribeDatabase
342
342
parameters :
343
343
- name : db
344
344
in : path
@@ -362,9 +362,9 @@ paths:
362
362
/api/v1/databases/{db}/drop :
363
363
delete :
364
364
tags :
365
- - TigrisDB
365
+ - Tigris
366
366
description : Drop database deletes all the collections in the database along with all it documents.
367
- operationId : TigrisDB_DropDatabase
367
+ operationId : Tigris_DropDatabase
368
368
parameters :
369
369
- name : db
370
370
in : path
@@ -388,8 +388,8 @@ paths:
388
388
/api/v1/databases/{db}/stream :
389
389
post :
390
390
tags :
391
- - TigrisDB
392
- operationId : TigrisDB_Stream
391
+ - Tigris
392
+ operationId : Tigris_Stream
393
393
parameters :
394
394
- name : db
395
395
in : path
@@ -412,11 +412,11 @@ paths:
412
412
/api/v1/databases/{db}/transactions/begin :
413
413
post :
414
414
tags :
415
- - TigrisDB
415
+ - Tigris
416
416
description : |-
417
417
Starts a new transaction and returns a transactional object. All reads/writes performed
418
418
within a transaction will run with serializable isolation.
419
- operationId : TigrisDB_BeginTransaction
419
+ operationId : Tigris_BeginTransaction
420
420
parameters :
421
421
- name : db
422
422
in : path
@@ -440,11 +440,11 @@ paths:
440
440
/api/v1/databases/{db}/transactions/commit :
441
441
post :
442
442
tags :
443
- - TigrisDB
443
+ - Tigris
444
444
description : |-
445
445
Atomically commit all the changes performed in the context of the transaction. Commit provides all
446
446
or nothing semantics by ensuring no partial updates are in the database due to a transaction failure.
447
- operationId : TigrisDB_CommitTransaction
447
+ operationId : Tigris_CommitTransaction
448
448
parameters :
449
449
- name : db
450
450
in : path
@@ -468,11 +468,11 @@ paths:
468
468
/api/v1/databases/{db}/transactions/rollback :
469
469
post :
470
470
tags :
471
- - TigrisDB
471
+ - Tigris
472
472
description : |-
473
473
Rollback transaction discards all the changes
474
474
performed in the transaction
475
- operationId : TigrisDB_RollbackTransaction
475
+ operationId : Tigris_RollbackTransaction
476
476
parameters :
477
477
- name : db
478
478
in : path
@@ -895,4 +895,4 @@ components:
895
895
$ref : ' #/components/schemas/TransactionCtx'
896
896
description : Additional options to modify write requests.
897
897
tags :
898
- - name : TigrisDB
898
+ - name : Tigris
0 commit comments