Merge branch 'feature/PI-851-swagger_spec_refinement_part_2' into release/2025-03-12

Author: megan-bower4

infrastructure/swagger/05_paths.yaml

@@ -171,7 +171,7 @@ paths:
         - $ref: "#/components/parameters/ProductTeamId"
       responses:
         "400":
-          $ref: "#/components/responses/BadRequest"
+          $ref: "#/components/responses/CreateProductBadRequest"
         "200":
           description: "200 response"
           headers:
@@ -243,7 +243,7 @@ paths:
         - Options
       responses:
         "400":
-          $ref: "#/components/responses/BadRequest"
+          $ref: "#/components/responses/SearchProductBadRequest"
         "200":
           description: "200 response"
           headers:
@@ -307,8 +307,6 @@ paths:
       tags:
         - Options
       responses:
-        "400":
-          $ref: "#/components/responses/BadRequest"
         "200":
           description: "200 response"
           headers:
@@ -325,6 +323,8 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/Empty"
+        "400":
+          description: "400 response"
       x-amazon-apigateway-integration:
         responses:
           default:
@@ -374,8 +374,6 @@ paths:
       tags:
         - Options
       responses:
-        "400":
-          $ref: "#/components/responses/BadRequest"
         "200":
           description: "200 response"
           headers:
@@ -392,6 +390,8 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/Empty"
+        "404":
+          description: "404 response"
       x-amazon-apigateway-integration:
         responses:
           default:

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

@@ -153,10 +153,12 @@ components:
                         properties:
                           id:
                             type: string
-                          name:
+                          cpm_product_team_id:
                             type: string
                           product_team_id:
                             type: string
+                          name:
+                            type: string
                           ods_code:
                             type: string
                           status:
@@ -186,6 +188,7 @@ components:
                 cpm_product_team_id: "a9a9694d-001b-45ce-9f2a-6c9bf80ae0d0"
                 products:
                   - id: "P.1X3-XYZ"
+                    cpm_product_team_id: "a9a9694d-001b-45ce-9f2a-6c9bf80ae0d0"
                     product_team_id: "55e86121-3826-468c-a6f0-dd0f1fbc0259"
                     name: "My Great Product 1"
                     ods_code: "F5H1R"
@@ -198,6 +201,7 @@ components:
                 cpm_product_team_id: "152705aa-0342-487f-a654-64bba814a847"
                 products:
                   - id: "P.4Y6-ABC"
+                    cpm_product_team_id: "152705aa-0342-487f-a654-64bba814a847"
                     product_team_id: "24ac1857-f718-4905-813f-52da930c3ea1"
                     name: "My Great Product 3"
                     ods_code: "F5H1R"

infrastructure/swagger/12_components--responses.yaml

@@ -67,37 +67,23 @@ components:
             errors:
               - code: "CONFLICT"
                 message: "Product Team cannot be deleted as it still has associated Product Ids ['P.1X3-XYZ', 'P.4Y6-ABC']"
-    BadRequest:
-      description: Bad request (multiple error types)
-      content:
-        application/json:
-          schema:
-            $ref: "#/components/schemas/ErrorResponse"
-          examples:
-            MissingValue:
-              value:
-                errors:
-                  - code: "MISSING_VALUE"
-                    message: "<MISSING_FIELD>: field required"
-                  - code: "MISSING_VALUE"
-                    message: "Failed to validate data against '<QUESTIONNAIRE>': '<MISSING_FIELD>' is a required property"
-            ValidationError:
-              value:
-                errors:
-                  - code: "VALIDATION_ERROR"
-                    message: "Item already exists"
     SearchProductBadRequest:
       description: searchProduct Bad request
       content:
         application/json:
           schema:
             $ref: "#/components/schemas/ErrorResponse"
           examples:
-            ValidationError:
+            MissingParamValidationError:
               value:
                 errors:
                   - code: "VALIDATION_ERROR"
                     message: "SearchProductQueryParams.__root__: Please provide exactly one valid query parameter: {'product_team_id', 'organisation_code'}."
+            UnknownParamValidationError:
+              value:
+                errors:
+                  - code: "VALIDATION_ERROR"
+                    message: "SearchProductQueryParams.foo: extra fields not permitted"
     CreateProductTeamBadRequest:
       description: createProductTeam Bad request
       content:

scripts/infrastructure/swagger/merge.sh

@@ -88,7 +88,11 @@ function generate_public_swagger() {
     yq 'del(.security)' |
     yq 'del(.paths./_status)' |
     yq 'del(.. | select(has("StatusOK")).StatusOK)' |
-    yq 'del(.components.securitySchemes."${authoriser_name}")' \
+    yq 'del(.components.securitySchemes."${authoriser_name}")' |
+    yq 'del(.components.responses.CorsOK)' |
+    yq 'del(.components.schemas.Empty)' |
+    yq 'del(.tags[] | select(.name == "Options"))' |
+    yq 'del(.paths.*.options)' \
       >${PUBLIC_SWAGGER_FILE}
   echo "Generated ${PUBLIC_SWAGGER_FILE}"
   validate_yaml ${PUBLIC_SWAGGER_FILE}