fix: successful POST request always return a 201 response. Improve so…

…me descriptions
SwissOpenEM · Jan 23, 2025 · 2f3f904 · 2f3f904
1 parent 76d4849
commit 2f3f904
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 19 deletions.
diff --git a/backend/api/openapi.yaml b/backend/api/openapi.yaml
@@ -16,12 +16,12 @@ paths:
               $ref: "#/components/schemas/CreateDatasetBody"
         required: true
       responses:
-        "200":
+        "201":
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/CreateDatasetResp"
-          description: Successful Response
+          description: Dataset Created
         "422":
           content:
             application/json:
@@ -47,25 +47,25 @@ paths:
               $ref: "#/components/schemas/CreateJobBody"
         required: true
       responses:
-        "200":
+        "201":
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/CreateJobResp"
-          description: Successful Response
+          description: Job Created
         "422":
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/HTTPValidationError"
-          description: Validation Error
+          description: Data Validation Error
         "500":
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/InternalError"
           description: Internal Server Error
-      summary: Job Created
+      summary: Create Archiver Job
       tags:
         - archiving
   /s3/presignedUrls:
@@ -78,12 +78,12 @@ paths:
               $ref: "#/components/schemas/PresignedUrlBody"
         required: true
       responses:
-        "200":
+        "201":
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/PresignedUrlResp"
-          description: Successful Response
+          description: Presigned URLs created
         "422":
           content:
             application/json:
@@ -109,12 +109,12 @@ paths:
               $ref: "#/components/schemas/CompleteUploadBody"
         required: true
       responses:
-        "200":
+        "201":
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/CompleteUploadResp"
-          description: Successful Response
+          description: Upload completed
         "422":
           content:
             application/json:
@@ -140,12 +140,12 @@ paths:
               $ref: "#/components/schemas/AbortUploadBody"
         required: true
       responses:
-        "200":
+        "201":
           content:
             application/json:
               schema:
                 $ref: "#/components/schemas/AbortUploadResp"
-          description: Successful Response
+          description: Abort multipart upload requested
         "422":
           content:
             application/json:

diff --git a/backend/api/src/openapi_server/apis/archiving_api.py b/backend/api/src/openapi_server/apis/archiving_api.py
@@ -41,12 +41,12 @@
 @router.post(
     "/archiver/jobs",
     responses={
-        200: {"model": CreateJobResp, "description": "Successful Response"},
-        422: {"model": HTTPValidationError, "description": "Validation Error"},
+        201: {"model": CreateJobResp, "description": "Job Created"},
+        422: {"model": HTTPValidationError, "description": "Data Validation Error"},
         500: {"model": InternalError, "description": "Internal Server Error"},
     },
     tags=["archiving"],
-    summary="Job Created",
+    summary="Create Archiver Job",
     response_model_by_alias=True,
 )
 async def create_job(
@@ -60,7 +60,7 @@ async def create_job(
 @router.post(
     "/archiver/new_dataset",
     responses={
-        200: {"model": CreateDatasetResp, "description": "Successful Response"},
+        201: {"model": CreateDatasetResp, "description": "Dataset Created"},
         422: {"model": HTTPValidationError, "description": "Validation Error"},
         500: {"model": InternalError, "description": "Internal Server Error"},
     },

diff --git a/backend/api/src/openapi_server/apis/presigned_urls_api.py b/backend/api/src/openapi_server/apis/presigned_urls_api.py
@@ -43,7 +43,7 @@
 @router.post(
     "/s3/abortMultipartUpload",
     responses={
-        200: {"model": AbortUploadResp, "description": "Successful Response"},
+        201: {"model": AbortUploadResp, "description": "Abort multipart upload requested"},
         422: {"model": HTTPValidationError, "description": "Validation Error"},
         500: {"model": InternalError, "description": "Internal Server Error"},
     },
@@ -62,7 +62,7 @@ async def abort_multipart_upload(
 @router.post(
     "/s3/completeUpload",
     responses={
-        200: {"model": CompleteUploadResp, "description": "Successful Response"},
+        201: {"model": CompleteUploadResp, "description": "Upload completed"},
         422: {"model": HTTPValidationError, "description": "Validation Error"},
         500: {"model": InternalError, "description": "Internal Server Error"},
     },
@@ -81,7 +81,7 @@ async def complete_upload(
 @router.post(
     "/s3/presignedUrls",
     responses={
-        200: {"model": PresignedUrlResp, "description": "Successful Response"},
+        201: {"model": PresignedUrlResp, "description": "Presigned URLs created"},
         422: {"model": HTTPValidationError, "description": "Validation Error"},
         500: {"model": InternalError, "description": "Internal Server Error"},
     },