Merge branch 'refactor/implemet-crud-handlers-for-manager' of https:/…

…/github.com/lablup/backend.ai into refactor/implemet-crud-handlers-for-manager
lablup · Feb 4, 2025 · b910b73 · b910b73
2 parents 0bebe9f + 5cf5f3c
commit b910b73
Show file tree

Hide file tree

Showing 4 changed files with 289 additions and 18 deletions.
diff --git a/docs/manager/rest-reference/openapi.json b/docs/manager/rest-reference/openapi.json
@@ -139,11 +139,11 @@
       },
       "CompactVFolderInfoModel": {
         "properties": {
-          "status": {
+          "status_code": {
             "default": 200,
             "exclusiveMaximum": 600,
             "minimum": 100,
-            "title": "Status",
+            "title": "Status Code",
             "type": "integer"
           },
           "id": {
@@ -718,11 +718,11 @@
       },
       "ServeInfoModel": {
         "properties": {
-          "status": {
+          "status_code": {
             "default": 200,
             "exclusiveMaximum": 600,
             "minimum": 100,
-            "title": "Status",
+            "title": "Status Code",
             "type": "integer"
           },
           "endpoint_id": {
@@ -875,11 +875,11 @@
       },
       "SuccessResponseModel": {
         "properties": {
-          "status": {
+          "status_code": {
             "default": 200,
             "exclusiveMaximum": 600,
             "minimum": 100,
-            "title": "Status",
+            "title": "Status Code",
             "type": "integer"
           },
           "success": {
@@ -919,11 +919,11 @@
       },
       "ErrorListResponseModel": {
         "properties": {
-          "status": {
+          "status_code": {
             "default": 200,
             "exclusiveMaximum": 600,
             "minimum": 100,
-            "title": "Status",
+            "title": "Status Code",
             "type": "integer"
           },
           "errors": {
@@ -961,11 +961,11 @@
       },
       "ScaleResponseModel": {
         "properties": {
-          "status": {
+          "status_code": {
             "default": 200,
             "exclusiveMaximum": 600,
             "minimum": 100,
-            "title": "Status",
+            "title": "Status Code",
             "type": "integer"
           },
           "current_route_count": {
@@ -1044,11 +1044,11 @@
       },
       "TokenResponseModel": {
         "properties": {
-          "status": {
+          "status_code": {
             "default": 200,
             "exclusiveMaximum": 600,
             "minimum": 100,
-            "title": "Status",
+            "title": "Status Code",
             "type": "integer"
           },
           "token": {
@@ -1082,11 +1082,11 @@
       },
       "SessionStatusResponseModel": {
         "properties": {
-          "status": {
+          "status_code": {
             "default": 200,
             "exclusiveMaximum": 600,
             "minimum": 100,
-            "title": "Status",
+            "title": "Status Code",
             "type": "integer"
           },
           "session_status_map": {
@@ -1177,11 +1177,11 @@
       },
       "ConvertSessionToImageResponseModel": {
         "properties": {
-          "status": {
+          "status_code": {
             "default": 200,
             "exclusiveMaximum": 600,
             "minimum": 100,
-            "title": "Status",
+            "title": "Status Code",
             "type": "integer"
           },
           "task_id": {

diff --git a/src/ai/backend/manager/api/utils.py b/src/ai/backend/manager/api/utils.py
@@ -215,7 +215,7 @@ async def wrapped(request: web.Request, *args: P.args, **kwargs: P.kwargs) -> TA
 
 
 class BaseResponseModel(BaseModel):
-    status: Annotated[int, Field(strict=True, exclude=True, ge=100, lt=600)] = 200
+    status_code: Annotated[int, Field(strict=True, exclude=True, ge=100, lt=600)] = 200
 
 
 TParamModel = TypeVar("TParamModel", bound=BaseModel)
@@ -235,7 +235,7 @@ def ensure_stream_response_type(
     response: BaseResponseModel | BaseModel | list[TResponseModel] | web.StreamResponse,
 ) -> web.StreamResponse:
     match response:
-        case BaseResponseModel(status=status):
+        case BaseResponseModel(status_code=status):
             return web.json_response(response.model_dump(mode="json"), status=status)
         case BaseModel():
             return web.json_response(response.model_dump(mode="json"))

diff --git a/src/ai/backend/manager/api/vfolders/protocols.py b/src/ai/backend/manager/api/vfolders/protocols.py
@@ -0,0 +1,71 @@
+import uuid
+from typing import (
+    Protocol,
+    Sequence,
+)
+
+from aiohttp import web
+
+from .types import (
+    CreatedResponseModel,
+    Keypair,
+    NoContentResponseModel,
+    UserIdentity,
+    VFolderCreateRequestModel,
+    VFolderCreateRequirements,
+    VFolderCreateResponseModel,
+    VFolderDeleteRequestModel,
+    VFolderList,
+    VFolderListRequestModel,
+    VFolderListResponseModel,
+    VFolderMetadata,
+    VFolderRenameRequestModel,
+)
+
+
+class VFolderHandlerProtocol(Protocol):
+    async def create_vfolder(
+        self, request: web.Request, params: VFolderCreateRequestModel
+    ) -> VFolderCreateResponseModel: ...
+
+    async def list_vfolders(
+        self, request: web.Request, params: VFolderListRequestModel
+    ) -> VFolderListResponseModel: ...
+
+    async def rename_vfodler(
+        self, request: web.Request, params: VFolderRenameRequestModel
+    ) -> CreatedResponseModel: ...
+
+    async def delete_vfolder(
+        self, request: web.Request, params: VFolderDeleteRequestModel
+    ) -> NoContentResponseModel: ...
+
+
+class VFolderServiceProtocol(Protocol):
+    async def create_vfolder_in_personal(
+        self,
+        user_identity: UserIdentity,
+        keypair: Keypair,
+        vfolder_create_requirements: VFolderCreateRequirements,
+    ) -> VFolderMetadata: ...
+
+    async def create_vfolder_in_group(
+        self,
+        user_identity: UserIdentity,
+        keypair: Keypair,
+        vfolder_create_requirements: VFolderCreateRequirements,
+    ) -> VFolderMetadata: ...
+
+    async def get_vfolders(self, user_identity: UserIdentity) -> VFolderList: ...
+
+    async def rename_vfolder(
+        self, user_identity: UserIdentity, vfolder_id: uuid.UUID, new_name: str
+    ) -> None: ...
+
+    async def delete_vfolder(
+        self,
+        vfolder_id: uuid.UUID,
+        user_identity: UserIdentity,
+        allowed_vfolder_types: Sequence[str],
+        keypair: Keypair,
+    ) -> None: ...