QA changes

Author: jameslinnell

infrastructure/swagger/05_paths.yaml

@@ -232,15 +232,19 @@ paths:
     delete:
       operationId: deleteproductendpoint
       summary: Delete a Product resource (DELETE)
+      description: |
+        - Delete a product using a product team ID and product ID.
+      tags:
+        - Core Product ID Endpointsurce (DELETE)
       parameters:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/ProductId"
         - $ref: "#/components/parameters/HeaderVersion"
         - $ref: "#/components/parameters/HeaderRequestId"
         - $ref: "#/components/parameters/HeaderCorrelationId"
       responses:
-        "204":
-          description: Delete Product operation successful
+        "200":
+          $ref: "#/components/responses/ProductDelete"
         "404":
           $ref: "#/components/responses/NotFound"
       x-amazon-apigateway-integration:

infrastructure/swagger/07_components--schemas--domain.yaml

@@ -183,7 +183,16 @@ components:
         created_on: "2024-10-15T10:00:00Z"
         updated_on: "null"
         deleted_on: "null"
-
+    CPMProductDeleteResponse:
+      type: object
+      properties:
+        code:
+          type: string
+        message:
+          type: string
+      example:
+        code: "RESOURCE_DELETED"
+        message: "P.XYZ-123 has been deleted."
     Questionnaire:
       type: object
       properties:

infrastructure/swagger/12_components--responses.yaml

@@ -145,6 +145,12 @@ components:
         application/json:
           schema:
             $ref: "#/components/schemas/CPMProductResponse"
+    ProductDelete:
+      description: Delete Product operation successful
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/CPMProductDeleteResponse"
     EprProductCreate:
       description: Create Epr Product operation successful
       content:

src/api/deleteCpmProduct/src/v1/steps.py

@@ -16,7 +16,10 @@ def delete_product(data, cache) -> CpmProduct:
 
 def set_http_status(data, cache) -> tuple[int, None]:
     product: CpmProduct = data[read_product]
-    return HTTPStatus.OK, {"code": "200", "message": f"{product.id} has been deleted."}
+    return HTTPStatus.OK, {
+        "code": "RESOURCE_DELETED",
+        "message": f"{product.id} has been deleted.",
+    }
 
 
 steps = [

src/api/deleteCpmProduct/tests/test_index.py

@@ -73,7 +73,7 @@ def test_index():
         assert response["statusCode"] == 200
         assert (
             response["body"]
-            == '{"code": "200", "message": "P.AAA-AAA has been deleted."}'
+            == '{"code": "RESOURCE_DELETED", "message": "P.AAA-AAA has been deleted."}'
         )
 
         # Retrieve the created resource

src/api/tests/feature_tests/features/deleteCpmProduct.success.feature

@@ -22,12 +22,12 @@ Feature: Delete CPM Product - success scenarios
     When I make a "DELETE" request with "default" headers to "ProductTeam/<product_team_id>/Product/${ note(product_id) }"
     Then I receive a status code "200" with body
       | path    | value                                   |
-      | code    | 200                                     |
+      | code    | RESOURCE_DELETED                        |
       | message | ${ note(product_id) } has been deleted. |
     And the response headers contain:
       | name           | value            |
       | Content-Type   | application/json |
-      | Content-Length | 57               |
+      | Content-Length | 70               |
 
     Examples:
       | product_team_id            |