refactor: change of response codes for creating and deleting tasks

oqtopus-team · Oct 11, 2024 · 6465b2a · 6465b2a
1 parent a70c054
commit 6465b2a
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 20 deletions.
diff --git a/backend/oas/user/openapi.yaml b/backend/oas/user/openapi.yaml
@@ -148,7 +148,7 @@ paths:
                   nShots: 1000
                   note: Bell State Sampling Example
       responses:
-        '200':
+        '201':
           description: Task submitted
           content:
             application/json:
@@ -237,7 +237,7 @@ paths:
           schema:
             type: string
       responses:
-        '200':
+        '204':
           description: Quantum task deleted
           content:
             application/json:
@@ -447,7 +447,7 @@ paths:
                         - -2.e-8
                   note: Bell State Estimation Example
       responses:
-        '200':
+        '201':
           description: Task submitted
           content:
             application/json:
@@ -561,7 +561,7 @@ paths:
           schema:
             type: string
       responses:
-        '200':
+        '204':
           description: Quantum task deleted
           content:
             application/json:

diff --git a/backend/oas/user/paths/tasks.yaml b/backend/oas/user/paths/tasks.yaml
@@ -71,7 +71,7 @@ tasks.sampling:
                 }
 
     responses:
-      "200":
+      "201":
         description: "Task submitted"
         content:
           application/json:
@@ -159,7 +159,7 @@ tasks.sampling.taskId:
           description: "Task identifier"
           schema: {type: string}
     responses:
-      "200":
+      "204":
         description: "Quantum task deleted"
         content:
           application/json:
@@ -373,7 +373,7 @@ tasks.estimation:
                 }
 
     responses:
-      "200":
+      "201":
         description: "Task submitted"
         content:
           application/json:
@@ -487,7 +487,7 @@ tasks.estimation.taskId:
           description: "Task identifier"
           schema: {type: string}
     responses:
-      "200":
+      "204":
         description: "Quantum task deleted"
         content:
           application/json:

diff --git a/backend/oqtopus_cloud/user/routers/tasks.py b/backend/oqtopus_cloud/user/routers/tasks.py
@@ -7,6 +7,7 @@
 from fastapi import (
     APIRouter,
     Depends,
+    status,
 )
 from fastapi import Request as Event
 from pydantic import ValidationError
@@ -315,6 +316,7 @@ def get_resources(
 
 @router.post(
     "/tasks/sampling",
+    status_code=status.HTTP_201_CREATED,
     response_model=SubmitTaskResponse,
     responses={400: {"model": Detail}, 500: {"model": Detail}},
 )
@@ -460,15 +462,16 @@ def get_sampling_task(
 
 @router.delete(
     "/tasks/sampling/{taskId}",
-    response_model=SuccessResponse,
+    status_code=status.HTTP_204_NO_CONTENT,
+    response_model=None,
     responses={400: {"model": Detail}, 404: {"model": Detail}, 500: {"model": Detail}},
 )
 @tracer.capture_method
 def delete_sampling_task(
     event: Event,
     taskId: str,
     db: Session = Depends(get_db),
-) -> SuccessResponse | ErrorResponse:
+) -> None | ErrorResponse:
     try:
         TaskId(root=uuid.UUID(taskId))
     except ValidationError:
@@ -494,7 +497,7 @@ def delete_sampling_task(
 
         db.delete(task)
         db.commit()
-        return SuccessResponse(message="task deleted")
+        return
     except Exception as e:
         logger.info(f"error: {str(e)}")
         return InternalServerErrorResponse(detail=str(e))
@@ -611,6 +614,7 @@ def get_estimation_tasks(
 
 @router.post(
     "/tasks/estimation",
+    status_code=status.HTTP_201_CREATED,
     response_model=SubmitTaskResponse,
     responses={400: {"model": Detail}, 500: {"model": Detail}},
 )
@@ -784,15 +788,16 @@ def get_estimation_task(
 
 @router.delete(
     "/tasks/estimation/{taskId}",
-    response_model=SuccessResponse,
+    status_code=status.HTTP_204_NO_CONTENT,
+    response_model=None,
     responses={400: {"model": Detail}, 404: {"model": Detail}, 500: {"model": Detail}},
 )
 @tracer.capture_method
 def delete_estimation_task(
     event: Event,
     taskId: str,
     db: Session = Depends(get_db),
-) -> SuccessResponse | ErrorResponse:
+) -> None | ErrorResponse:
     try:
         TaskId(root=uuid.UUID(taskId))
     except ValidationError:
@@ -818,7 +823,7 @@ def delete_estimation_task(
 
         db.delete(task)
         db.commit()
-        return SuccessResponse(message="task deleted")
+        return
     except Exception as e:
         logger.info(f"error: {str(e)}")
         return InternalServerErrorResponse(detail=str(e))

diff --git a/backend/tests/oqtopus_cloud/user/routers/test_tasks.py b/backend/tests/oqtopus_cloud/user/routers/test_tasks.py
@@ -84,7 +84,7 @@
 #     }
 
 
-# def test_post_task_200(
+# def test_post_task_201(
 #     test_db,
 # ):
 #     """_summary_
@@ -123,4 +123,4 @@
 #         note=None,
 #     )
 #     response = client.post("/tasks", content=body.model_dump_json())
-#     assert response.status_code == 200
+#     assert response.status_code == 201
diff --git a/docs/oas/user/openapi.yaml b/docs/oas/user/openapi.yaml
@@ -148,7 +148,7 @@ paths:
                   nShots: 1000
                   note: Bell State Sampling Example
       responses:
-        '200':
+        '201':
           description: Task submitted
           content:
             application/json:
@@ -237,7 +237,7 @@ paths:
           schema:
             type: string
       responses:
-        '200':
+        '204':
           description: Quantum task deleted
           content:
             application/json:
@@ -447,7 +447,7 @@ paths:
                         - -2.e-8
                   note: Bell State Estimation Example
       responses:
-        '200':
+        '201':
           description: Task submitted
           content:
             application/json:
@@ -561,7 +561,7 @@ paths:
           schema:
             type: string
       responses:
-        '200':
+        '204':
           description: Quantum task deleted
           content:
             application/json: