fix: simplify describe AP response

Author: efirs

.github/workflows/lint.yaml

@@ -15,5 +15,9 @@ jobs:
           go-version: '1.17.6'
       - name: Install dependencies
         run: /bin/bash scripts/install_build_deps.sh
-      - name: make lint
+      - name: Check OpenAPI generated
+        run: |
+          make generate
+          git diff --quiet HEAD || (echo -e "\nRun 'make clean && make generate' and check-in OpenAPI specification" && exit 1)
+      - name: Make lint
         run: make lint

scripts/fix_openapi.sh

@@ -70,6 +70,8 @@ yq_fix_object CreateOrUpdateCollectionRequest schema
 yq_fix_timestamp ResponseMetadata created_at
 yq_fix_timestamp ResponseMetadata updated_at
 
+yq_fix_object DescribeCollectionResponse schema
+yq_fix_object CollectionDescription schema
 
 for i in InsertRequest ReplaceRequest UpdateRequest DeleteRequest ReadRequest \
 	CreateOrUpdateCollectionRequest DropCollectionRequest \

server/v1/api.proto

@@ -385,42 +385,45 @@ message DescribeCollectionRequest {
   CollectionOptions options = 3;
 }
 
+// A detailed description about the database and all associated collections.
+// Description of the collection includes schema details as well.
 message DescribeDatabaseResponse {
-  // A detailed description about the database and all associated collections. Description of the collection
-  // includes schema details as well.
-  DatabaseDescription description = 1;
-}
-
-message DescribeCollectionResponse {
-  // A detailed description about the collection. The description returns collection metadata and the schema.
-  CollectionDescription description = 1;
-}
-
-message DatabaseDescription {
   // Name of the database.
   string db = 1;
 
   // Metadata about the database.
   DatabaseMetadata metadata = 2;
 
-  // A detailed description about all the collections. The description returns collection metadata and the schema.
-  repeated CollectionDescription collections_description = 3;
+  // A detailed description about all the collections.
+  // The description returns collection metadata and the schema.
+  repeated CollectionDescription collections = 3;
 }
 
-message CollectionDescription {
+// A detailed description about the collection.
+// The description returns collection metadata and the schema.
+message DescribeCollectionResponse {
   // Name of the collection.
   string collection = 1;
 
   // Metadata about the collection.
   CollectionMetadata metadata = 2;
 
-  // A detailed description about the collection. The description returns collection metadata and the schema.
-  SchemaInfo schema_info = 3;
+  // Collections schema
+  bytes schema = 3;
+}
+
+message DatabaseDescription {
 }
 
-message SchemaInfo {
-  // The schema of the collection.
-  bytes schema = 1;
+message CollectionDescription {
+  // Name of the collection.
+  string collection = 1;
+
+  // Metadata about the collection.
+  CollectionMetadata metadata = 2;
+
+  // Collections schema
+  bytes schema = 3;
 }
 
 message DatabaseMetadata {

server/v1/api_openapi.yaml

@@ -515,8 +515,9 @@ components:
                     description: Name of the collection.
                 metadata:
                     $ref: '#/components/schemas/CollectionMetadata'
-                schema_info:
-                    $ref: '#/components/schemas/SchemaInfo'
+                schema:
+                    type: object
+                    description: Collections schema
         CollectionInfo:
             type: object
             properties:
@@ -542,7 +543,10 @@ components:
             description: Commit transaction with the given ID
         CommitTransactionResponse:
             type: object
-            properties: {}
+            properties:
+                status:
+                    type: string
+                    description: Status of commit transaction operation.
         CreateDatabaseRequest:
             type: object
             properties:
@@ -576,19 +580,6 @@ components:
                 status:
                     type: string
                     description: An enum with value set as "created" or "updated"
-        DatabaseDescription:
-            type: object
-            properties:
-                db:
-                    type: string
-                    description: Name of the database.
-                metadata:
-                    $ref: '#/components/schemas/DatabaseMetadata'
-                collections_description:
-                    type: array
-                    items:
-                        $ref: '#/components/schemas/CollectionDescription'
-                    description: A detailed description about all the collections. The description returns collection metadata and the schema.
         DatabaseInfo:
             type: object
             properties:
@@ -635,11 +626,20 @@ components:
                 collection:
                     type: string
                     description: Name of the collection.
+                options:
+                    $ref: '#/components/schemas/CollectionOptions'
         DescribeCollectionResponse:
             type: object
             properties:
-                description:
-                    $ref: '#/components/schemas/CollectionDescription'
+                collection:
+                    type: string
+                    description: Name of the collection.
+                metadata:
+                    $ref: '#/components/schemas/CollectionMetadata'
+                schema:
+                    type: object
+                    description: Collections schema
+            description: A detailed description about the collection. The description returns collection metadata and the schema.
         DescribeDatabaseRequest:
             type: object
             properties:
@@ -649,8 +649,17 @@ components:
         DescribeDatabaseResponse:
             type: object
             properties:
-                description:
-                    $ref: '#/components/schemas/DatabaseDescription'
+                db:
+                    type: string
+                    description: Name of the database.
+                metadata:
+                    $ref: '#/components/schemas/DatabaseMetadata'
+                collections:
+                    type: array
+                    items:
+                        $ref: '#/components/schemas/CollectionDescription'
+                    description: A detailed description about all the collections. The description returns collection metadata and the schema.
+            description: A detailed description about the database and all associated collections. Description of the collection includes schema details as well.
         DropCollectionRequest:
             type: object
             properties:
@@ -811,15 +820,11 @@ components:
                     $ref: '#/components/schemas/TransactionCtx'
             description: Rollback transaction with the given ID
         RollbackTransactionResponse:
-            type: object
-            properties: {}
-        SchemaInfo:
             type: object
             properties:
-                schema:
+                status:
                     type: string
-                    description: The schema of the collection.
-                    format: byte
+                    description: Status of rollback transaction operation.
         StreamChange:
             type: object
             properties: