Merge branch '601-dblab-api-endpoints' into 'dle-4-0'

Refactor API endpoints

See merge request postgres-ai/database-lab!994

Author: Bogdan Tsechoev

engine/api/postman/dblab_api.postman_collection.json

@@ -16,7 +16,7 @@ info:
   license:
     name: Apache 2.0
     url: https://github.com/postgres-ai/database-lab-engine/blob/dle-4-0/LICENSE
-  version: 4.0.0-alpha.5
+  version: 4.0.0
 externalDocs:
   description: DBLab Docs
   url: https://gitlab.com/postgres-ai/docs/tree/master/docs/database-lab
@@ -224,6 +224,84 @@ paths:
               example:
                 code: "UNAUTHORIZED"
                 message: "Check your verification token."
+  /snapshot:
+    post:
+      tags:
+        - Snapshots
+      summary: Create a snapshot
+      description: "Create a new snapshot from the current state of the selected pool.
+        This snapshot can later be used to create clones or new branches."
+      parameters:
+        - name: Verification-Token
+          in: header
+          required: true
+          schema:
+            type: string
+      requestBody:
+        description: "Optional parameters for snapshot creation.
+          If no pool name is provided, the first available pool is used."
+        content:
+          '*/*':
+            schema:
+              type: object
+              properties:
+                poolName:
+                  type: string
+                  description: Name of the pool to create snapshot in.
+        required: false
+      responses:
+        200:
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Snapshot'
+        400:
+          description: Bad request
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Error'
+      x-codegen-request-body-name: body
+  /snapshot/{id}:
+    delete:
+      tags:
+        - Snapshots
+      summary: Delete a snapshot
+      description: "Permanently delete the specified snapshot.
+        If the snapshot has dependent clones or datasets, `force=true` can be provided as a query parameter."
+      parameters:
+        - name: id
+          in: path
+          required: true
+          description: The ID of the snapshot to delete.
+          schema:
+            type: string
+            pattern: '.*'
+        - name: force
+          in: query
+          required: false
+          description: Force deletion even if dependent clones or datasets exist.
+          schema:
+            type: boolean
+        - name: Verification-Token
+          in: header
+          required: true
+          schema:
+            type: string
+      responses:
+        200:
+          description: OK
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/ResponseStatus'
+        400:
+          description: Bad request
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/Error'
   /clones:
     get:
       tags:
@@ -715,7 +793,7 @@ paths:
             '*/*':
               schema:
                 $ref: '#/components/schemas/Error'
-  /branch/create:
+  /branch:
     post:
       tags:
       - Branches
@@ -805,28 +883,24 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
       x-codegen-request-body-name: body
-  /branch/delete:
-    post:
+  /branch/{branchName}:
+    delete:
       tags:
       - Branches
       summary: Delete a branch
       description: "Permanently delete the specified branch. It cannot be undone."
       parameters:
-      - name: Verification-Token
-        in: header
-        required: true
-        schema:
-          type: string
-      requestBody:
-        content:
-          '*/*':
-            schema:
-              type: object
-              properties:
-                branchName:
-                  type: string
-                  description: "The name of the branch to be deleted."
-        required: true
+        - name: branchName
+          in: path
+          required: true
+          schema:
+            type: string
+            description: "The name of the branch to be deleted."
+        - name: Verification-Token
+          in: header
+          required: true
+          schema:
+            type: string
       responses:
         200:
           description: OK
@@ -841,28 +915,24 @@ paths:
               schema:
                 $ref: '#/components/schemas/Error'
       x-codegen-request-body-name: body
-  /branch/log:
-    post:
+  /branch/{branchName}/log:
+    get:
       tags:
       - Branches
       summary: Retrieve a branch log
       description: Retrieve a log of the specified branch (history of snapshots).
       parameters:
-      - name: Verification-Token
-        in: header
-        required: true
-        schema:
-          type: string
-      requestBody:
-        content:
-          '*/*':
-            schema:
-              type: object
-              properties:
-                branchName:
-                  type: string
-                  description: The name of the branch.
-        required: false
+        - name: branchName
+          in: path
+          required: true
+          schema:
+            type: string
+            description: The name of the branch.
+        - name: Verification-Token
+          in: header
+          required: true
+          schema:
+            type: string
       responses:
         200:
           description: OK

engine/api/swagger-spec/dblab_openapi.yaml

@@ -458,13 +458,9 @@ func filterSnapshotsByBranch(pool *resources.Pool, branch string, snapshots []mo
 }
 
 func (s *Server) log(w http.ResponseWriter, r *http.Request) {
-	var logRequest types.LogRequest
-	if err := api.ReadJSON(r, &logRequest); err != nil {
-		api.SendBadRequestError(w, r, err.Error())
-		return
-	}
+	branchName := mux.Vars(r)["branchName"]
 
-	fsm, err := s.getFSManagerForBranch(logRequest.BranchName)
+	fsm, err := s.getFSManagerForBranch(branchName)
 	if err != nil {
 		api.SendBadRequestError(w, r, err.Error())
 		return
@@ -481,9 +477,9 @@ func (s *Server) log(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	snapshotID, ok := repo.Branches[logRequest.BranchName]
+	snapshotID, ok := repo.Branches[branchName]
 	if !ok {
-		api.SendBadRequestError(w, r, "branch not found: "+logRequest.BranchName)
+		api.SendBadRequestError(w, r, "branch not found: "+branchName)
 		return
 	}
 
@@ -508,13 +504,9 @@ func (s *Server) log(w http.ResponseWriter, r *http.Request) {
 }
 
 func (s *Server) deleteBranch(w http.ResponseWriter, r *http.Request) {
-	var deleteRequest types.BranchDeleteRequest
-	if err := api.ReadJSON(r, &deleteRequest); err != nil {
-		api.SendBadRequestError(w, r, err.Error())
-		return
-	}
+	branchName := mux.Vars(r)["branchName"]
 
-	fsm, err := s.getFSManagerForBranch(deleteRequest.BranchName)
+	fsm, err := s.getFSManagerForBranch(branchName)
 	if err != nil {
 		api.SendBadRequestError(w, r, err.Error())
 		return
@@ -531,13 +523,13 @@ func (s *Server) deleteBranch(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 
-	snapshotID, ok := repo.Branches[deleteRequest.BranchName]
+	snapshotID, ok := repo.Branches[branchName]
 	if !ok {
-		api.SendBadRequestError(w, r, "branch not found: "+deleteRequest.BranchName)
+		api.SendBadRequestError(w, r, "branch not found: "+branchName)
 		return
 	}
 
-	toRemove := snapshotsToRemove(repo, snapshotID, deleteRequest.BranchName)
+	toRemove := snapshotsToRemove(repo, snapshotID, branchName)
 
 	if len(toRemove) > 0 {
 		// Pre-check.
@@ -550,7 +542,7 @@ func (s *Server) deleteBranch(w http.ResponseWriter, r *http.Request) {
 		}
 
 		if len(preCheckList) > 0 {
-			errMsg := fmt.Sprintf("cannot delete branch %q because", deleteRequest.BranchName)
+			errMsg := fmt.Sprintf("cannot delete branch %q because", branchName)
 
 			for snapID, cloneNum := range preCheckList {
 				errMsg += fmt.Sprintf(" snapshot %q contains %d clone(s)", snapID, cloneNum)
@@ -563,7 +555,7 @@ func (s *Server) deleteBranch(w http.ResponseWriter, r *http.Request) {
 		}
 	}
 
-	if err := s.destroyBranchDataset(fsm, deleteRequest.BranchName); err != nil {
+	if err := s.destroyBranchDataset(fsm, branchName); err != nil {
 		api.SendBadRequestError(w, r, err.Error())
 		return
 	}