Update swagger

Author: jameslinnell

infrastructure/swagger/05_paths.yaml

@@ -50,7 +50,7 @@ paths:
         - Options
       responses:
         "400":
-          $ref: "#/components/responses/BadRequest"
+          $ref: "#/components/responses/CreateProductTeamBadRequest"
         "200":
           description: "200 response"
           headers:
@@ -95,7 +95,7 @@ paths:
         "201":
           $ref: "#/components/responses/CPMProductTeamCreate"
         "400":
-          $ref: "#/components/responses/BadRequest"
+          $ref: "#/components/responses/CreateProductTeamBadRequest"
         "422":
           $ref: "#/components/responses/UnprocessableContent"
       parameters:

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

@@ -62,8 +62,8 @@ components:
         updated_on: "null"
         deleted_on: "null"
         keys:
-          - key_type: "product_team_id_alias"
-            key_value: "FOOBAR"
+          - key_type: "product_team_id"
+            key_value: "55e86121-3826-468c-a6f0-dd0f1fbc0259"
     CPMProductTeamDeleteResponse:
       type: object
       properties:
@@ -81,7 +81,7 @@ components:
           type: string
         name:
           type: string
-        product_team_id:
+        cpm_product_team_id:
           type: string
         ods_code:
           type: string
@@ -107,7 +107,7 @@ components:
       example:
         id: "P.1X3-XXX"
         name: "Sample Product"
-        product_team_id: "55e86121-3826-468c-a6f0-dd0f1fbc0259"
+        cpm_product_team_id: "55e86121-3826-468c-a6f0-dd0f1fbc0259"
         ods_code: "F5H1R"
         keys: []
         status: "active"

infrastructure/swagger/12_components--responses.yaml

@@ -71,6 +71,33 @@ components:
                 errors:
                   - code: "VALIDATION_ERROR"
                     message: "SearchProductQueryParams.__root__: Please provide exactly one valid query parameter: {'product_team_id', 'organisation_code'}."
+    CreateProductTeamBadRequest:
+      description: searchProductTeam Bad request
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/ErrorResponse"
+          examples:
+            NotPermittedValidationError:
+              value:
+                errors:
+                  - code: "VALIDATION_ERROR"
+                    message: "CreateProductTeamIncomingParams.keys.0.key_type: value is not a valid enumeration member; permitted: 'product_team_id'"
+            FormatValidationError:
+              value:
+                errors:
+                  - code: "VALIDATION_ERROR"
+                    message: "CreateProductTeamIncomingParams.keys.0.key_value: Key '' does not match the expected pattern '^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$' associated with key type 'product_team_id'"
+            DuplicateKeyValidationError:
+              value:
+                errors:
+                  - code: "VALIDATION_ERROR"
+                    message: "CreateProductTeamIncomingParams.keys: Ensure that product_team_id only exists once within keys."
+            MissingValue:
+              value:
+                errors:
+                  - code: "MISSING_VALUE"
+                    message: "CreateProductTeamIncomingParams.ods_code: field required"
       headers:
         Access-Control-Allow-Origin:
           schema: