feat: Schema format options

tigrisdata-archive · Oct 28, 2022 · 452d3c5 · 452d3c5
1 parent ec27094
commit 452d3c5
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/server/v1/api.proto b/server/v1/api.proto
@@ -575,6 +575,11 @@ message ListCollectionsResponse {
 message DescribeDatabaseRequest {
   // Name of the database.
   string db = 1;
+
+  // Return schema in the requested format.
+  // Format can be JSON, Go, TypeScript, Java.
+  // Default is JSON.
+  string schema_format = 2;
 }
 
 message DescribeCollectionRequest {
@@ -584,8 +589,13 @@ message DescribeCollectionRequest {
   // Name of the collection.
   string collection = 2;
 
+  // Return schema in the requested format.
+  // Format can be JSON, Go, TypeScript, Java.
+  // Default is JSON.
+  string schema_format = 3;
+
   // Collection options.
-  CollectionOptions options = 3;
+  CollectionOptions options = 4;
 }
 
 // A detailed description of the database and all the associated collections.

diff --git a/server/v1/openapi.yaml b/server/v1/openapi.yaml
@@ -1408,6 +1408,9 @@ components:
                 collection:
                     type: string
                     description: Name of the collection.
+                schema_format:
+                    type: string
+                    description: Return schema in the requested format. Format can be JSON, Go, TypeScript, Java. Default is JSON.
                 options:
                     $ref: '#/components/schemas/CollectionOptions'
         DescribeCollectionResponse:
@@ -1432,6 +1435,9 @@ components:
                 db:
                     type: string
                     description: Name of the database.
+                schema_format:
+                    type: string
+                    description: Return schema in the requested format. Format can be JSON, Go, TypeScript, Java. Default is JSON.
         DescribeDatabaseResponse:
             type: object
             properties: