rename schemas on engine API

kurtosis-tech · Nov 17, 2023 · e6b882a · e6b882a
1 parent 27ec28f
commit e6b882a
Show file tree

Hide file tree

Showing 4 changed files with 70 additions and 93 deletions.
diff --git a/api/golang/engine/kurtosis_engine_rest_api_bindings/engine_server.gen.go b/api/golang/engine/kurtosis_engine_rest_api_bindings/engine_server.gen.go
diff --git a/api/golang/engine/kurtosis_engine_rest_api_bindings/engine_types.gen.go b/api/golang/engine/kurtosis_engine_rest_api_bindings/engine_types.gen.go
diff --git a/api/openapi/engine/engine_service.yaml b/api/openapi/engine/engine_service.yaml
@@ -1,7 +1,9 @@
 openapi: 3.0.0
+
 info:
   title: Engine API
-  version: 1.0.0
+  version: 0.1.0
+
 paths:
   /engine/info:
     get:
@@ -12,7 +14,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/GetEngineInfoResponse'
+                $ref: '#/components/schemas/EngineInfo'
 
   /enclaves:
     get:
@@ -23,7 +25,12 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/GetEnclavesResponse'
+                type: object
+                properties:
+                  enclave_info:
+                    type: object
+                    additionalProperties:
+                      $ref: '#/components/schemas/EnclaveInfo'
 
     post:
       summary: Create Enclave
@@ -32,14 +39,14 @@ paths:
         content:
           application/json:
             schema:
-              $ref: '#/components/schemas/CreateEnclaveArgs'
+              $ref: '#/components/schemas/CreateEnclave'
       responses:
         '200':
           description: Successful response
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/CreateEnclaveResponse'
+                $ref: '#/components/schemas/EnclaveInfo'
 
     delete:
       summary: Delete Enclaves
@@ -56,7 +63,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/DeleteResponse'
+                $ref: '#/components/schemas/DeletionSummary'
 
   /enclaves/historical:
     get:
@@ -67,7 +74,9 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/GetExistingAndHistoricalEnclaveIdentifiersResponse'
+                type: array
+                items:
+                  $ref: '#/components/schemas/EnclaveIdentifiers'
 
   /enclaves/{enclave_identifier}:
     get:
@@ -148,33 +157,23 @@ paths:
               schema:
                 type: object
 
-
+# =========================================================================================================================
+# =========================================================================================================================
+# > > > > > > > > > > > > > > > > > > > > > > > > Data Models < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < < 
+# =========================================================================================================================
+# =========================================================================================================================
 
 components:
+
   schemas:
-    GetEngineInfoResponse:
+
+    EngineInfo:
       type: object
       properties:
         engine_version:
           type: string
 
-    GetEnclavesResponse:
-      type: object
-      properties:
-        enclave_info:
-          type: object
-          additionalProperties:
-            $ref: '#/components/schemas/EnclaveInfo'
-
-    GetExistingAndHistoricalEnclaveIdentifiersResponse:
-      type: object
-      properties:
-        allIdentifiers:
-          type: array
-          items:
-            $ref: '#/components/schemas/EnclaveIdentifiers'
-
-    CreateEnclaveArgs:
+    CreateEnclave:
       type: object
       properties:
         enclave_name:
@@ -206,12 +205,6 @@ components:
         - STOPPED
         - NON_EXISTENT
 
-    CreateEnclaveResponse:
-      type: object
-      properties:
-        enclave_info:
-          $ref: '#/components/schemas/EnclaveInfo'
-
     EnclaveInfo:
       type: object
       properties:
@@ -273,7 +266,7 @@ components:
         uuid:
           type: string
 
-    DeleteResponse:
+    DeletionSummary:
       type: object
       properties:
         removed_enclave_name_and_uuids:

diff --git a/engine/server/engine/server/engine_rest_api_handler.go b/engine/server/engine/server/engine_rest_api_handler.go
@@ -175,7 +175,7 @@ func (engine EngineRuntime) DeleteEnclaves(ctx context.Context, request api.Dele
 		}
 	}
 	removedApiResponse := utils.MapList(removedEnclaveUuidsAndNames, toHttpApiEnclaveNameAndUuid)
-	return api.DeleteEnclaves200JSONResponse(api.DeleteResponse{RemovedEnclaveNameAndUuids: &removedApiResponse}), nil
+	return api.DeleteEnclaves200JSONResponse(api.DeletionSummary{RemovedEnclaveNameAndUuids: &removedApiResponse}), nil
 }
 
 // Get Enclaves
@@ -186,8 +186,10 @@ func (engine EngineRuntime) GetEnclaves(ctx context.Context, request api.GetEncl
 		return nil, stacktrace.Propagate(err, "An error occurred getting info for enclaves")
 	}
 	info_map_http := toHttpApiEnclaveInfos(infoForEnclaves)
-	response := api.GetEnclavesResponse{EnclaveInfo: &info_map_http}
-	return api.GetEnclaves200JSONResponse(response), nil
+	response := api.GetEnclaves200JSONResponse{
+		EnclaveInfo: &info_map_http,
+	}
+	return response, nil
 }
 
 // Create Enclave
@@ -220,11 +222,7 @@ func (engine EngineRuntime) PostEnclaves(ctx context.Context, request api.PostEn
 		return nil, stacktrace.Propagate(err, "An error occurred creating new enclave with name '%v'", request.Body.EnclaveName)
 	}
 
-	grpcEnclaveInfo := toHttpApiEnclaveInfo(*enclaveInfo)
-	response := api.CreateEnclaveResponse{
-		EnclaveInfo: &grpcEnclaveInfo,
-	}
-
+	response := toHttpApiEnclaveInfo(*enclaveInfo)
 	return api.PostEnclaves200JSONResponse(response), nil
 }
 
@@ -236,8 +234,7 @@ func (engine EngineRuntime) GetEnclavesHistorical(ctx context.Context, request a
 		return nil, stacktrace.Propagate(err, "An error occurred while fetching enclave identifiers")
 	}
 	identifiers_map_api := utils.MapList(allIdentifiers, toHttpApiEnclaveIdentifiers)
-	response := api.GetExistingAndHistoricalEnclaveIdentifiersResponse{AllIdentifiers: &identifiers_map_api}
-	return api.GetEnclavesHistorical200JSONResponse(response), nil
+	return api.GetEnclavesHistorical200JSONResponse(identifiers_map_api), nil
 }
 
 // Destroy Enclave
@@ -368,7 +365,7 @@ func (engine EngineRuntime) PostEnclavesEnclaveIdentifierStop(ctx context.Contex
 // Get Engine Info
 // (GET /engine/info)
 func (engine EngineRuntime) GetEngineInfo(ctx context.Context, request api.GetEngineInfoRequestObject) (api.GetEngineInfoResponseObject, error) {
-	result := api.GetEngineInfoResponse{EngineVersion: &engine.ImageVersionTag}
+	result := api.EngineInfo{EngineVersion: &engine.ImageVersionTag}
 	return api.GetEngineInfo200JSONResponse(result), nil
 }
 
@@ -440,7 +437,7 @@ func (service *EngineRuntime) reportAnyMissingUuidsAndGetNotFoundUuidsListHttp(
 
 	notFoundServiceUuidsMap := getNotFoundServiceUuidsAndEmptyServiceLogsMap(requestedServiceUuids, existingServiceUuids)
 	var notFoundServiceUuids []string
-	for service, _ := range notFoundServiceUuidsMap {
+	for service := range notFoundServiceUuidsMap {
 		notFoundServiceUuids = append(notFoundServiceUuids, service)
 	}
 	return notFoundServiceUuids, nil