Merge pull request #446 from NHSDigital/release/2024-12-16

Release/2024 12 16

Author: megan-bower4

.github/workflows/deploy-nonprod-workspace.yml

@@ -11,7 +11,7 @@ on:
         options:
           - dev
           - qa
-          # - int
+          - int
           - ref
       sandbox:
         description: Do you want to deploy the sandbox version?

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2024-12-16
+- [PI-681] EPR endpoints requirements
+- [PI-702] Prod bulk tweak
+- [PI-653] EPR create endpoints - forbid duplicate interactions
+- [PI-606] ETL Updates, with "add an mhs"
+
 ## 2024-12-11
 - [PI-650] Modify the Read Device endpoint for AS Devices
 - [PI-666] Create an ASID for AS Device and add as a DeviceKey

VERSION

@@ -1 +1 @@
-2024.12.11
+2024.12.16

changelog/2024-12-16.md

@@ -0,0 +1,4 @@
+- [PI-681] EPR endpoints requirements
+- [PI-702] Prod bulk tweak
+- [PI-653] EPR create endpoints - forbid duplicate interactions
+- [PI-606] ETL Updates, with "add an mhs"

infrastructure/swagger/05_paths.yaml

@@ -78,45 +78,49 @@ paths:
         - app-level0: []
 
   /ProductTeam/{product_team_id}/Product:
-    get:
-      operationId: searchCpmProduct
-      summary: Retrieve all Products associated with a Product Team (GET)
+    post:
+      operationId: createproductendpoint
+      summary: Create a Product resource (POST)
+      description: |
+        This endpoint creates a new Product resource for the specified Product Team.
+        **Requirements:**
+        - A valid Product Team must exist
       parameters:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/HeaderVersion"
         - $ref: "#/components/parameters/HeaderRequestId"
         - $ref: "#/components/parameters/HeaderCorrelationId"
+      requestBody:
+        $ref: "#/components/requestBodies/ProductCreateRequestBody"
       responses:
-        "200":
-          $ref: "#/components/responses/ProductSearch"
+        "201":
+          $ref: "#/components/responses/ProductCreate"
+        "400":
+          $ref: "#/components/responses/BadRequest"
         "404":
           $ref: "#/components/responses/NotFound"
       x-amazon-apigateway-integration:
         <<: *ApiGatewayIntegration
-        uri: ${method_searchCpmProduct}
+        uri: ${method_createCpmProduct}
       security:
         - ${authoriser_name}: []
         - app-level0: []
-    post:
-      operationId: createproductendpoint
-      summary: Create a Product resource (POST)
+    get:
+      operationId: searchCpmProduct
+      summary: Retrieve all Products associated with a Product Team (GET)
       parameters:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/HeaderVersion"
         - $ref: "#/components/parameters/HeaderRequestId"
         - $ref: "#/components/parameters/HeaderCorrelationId"
-      requestBody:
-        $ref: "#/components/requestBodies/ProductCreateRequestBody"
       responses:
-        "201":
-          $ref: "#/components/responses/ProductCreate"
-        "400":
-          $ref: "#/components/responses/BadRequest"
+        "200":
+          $ref: "#/components/responses/ProductSearch"
         "404":
           $ref: "#/components/responses/NotFound"
       x-amazon-apigateway-integration:
         <<: *ApiGatewayIntegration
-        uri: ${method_createCpmProduct}
+        uri: ${method_searchCpmProduct}
       security:
         - ${authoriser_name}: []
         - app-level0: []
@@ -142,7 +146,6 @@ paths:
       security:
         - ${authoriser_name}: []
         - app-level0: []
-
     delete:
       operationId: deleteproductendpoint
       summary: Delete a Product resource (DELETE)
@@ -168,6 +171,10 @@ paths:
     post:
       operationId: createproductforeprendpoint
       summary: Create an EPR Product resource (POST)
+      description: |
+        This endpoint creates a new EPR Product resource for the specified Product Team.
+        **Requirements:**
+        - A valid Product Team must exist
       parameters:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/HeaderVersion"
@@ -190,47 +197,48 @@ paths:
         - app-level0: []
 
   /ProductTeam/{product_team_id}/Product/{product_id}/DeviceReferenceData:
-    get:
-      operationId: searchDeviceReferenceData
-      summary: Retrieve all Data Reference Data resources associated with a Product (GET)
+    post:
+      operationId: createDeviceReferenceData
+      summary: Create a Device Reference Data resource (POST)
+      description: This endpoint has not yet been configured. Do not use.
       parameters:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/ProductId"
         - $ref: "#/components/parameters/HeaderVersion"
         - $ref: "#/components/parameters/HeaderRequestId"
         - $ref: "#/components/parameters/HeaderCorrelationId"
+      requestBody:
+        $ref: "#/components/requestBodies/DeviceReferenceDataCreateRequestBody"
       responses:
-        "200":
-          $ref: "#/components/responses/DeviceRefDataSearch"
+        "201":
+          $ref: "#/components/responses/DeviceRefDataCreate"
+        "400":
+          $ref: "#/components/responses/BadRequest"
         "404":
           $ref: "#/components/responses/NotFound"
       x-amazon-apigateway-integration:
         <<: *ApiGatewayIntegration
-        uri: ${method_searchDeviceReferenceData}
+        uri: ${method_createDeviceReferenceData}
       security:
         - ${authoriser_name}: []
         - app-level0: []
-    post:
-      operationId: createDeviceReferenceData
-      summary: Create a Device Reference Data resource (POST)
+    get:
+      operationId: searchDeviceReferenceData
+      summary: Retrieve all Data Reference Data resources associated with a Product (GET)
       parameters:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/ProductId"
         - $ref: "#/components/parameters/HeaderVersion"
         - $ref: "#/components/parameters/HeaderRequestId"
         - $ref: "#/components/parameters/HeaderCorrelationId"
-      requestBody:
-        $ref: "#/components/requestBodies/DeviceReferenceDataCreateRequestBody"
       responses:
-        "201":
-          $ref: "#/components/responses/DeviceRefDataCreate"
-        "400":
-          $ref: "#/components/responses/BadRequest"
+        "200":
+          $ref: "#/components/responses/DeviceRefDataSearch"
         "404":
           $ref: "#/components/responses/NotFound"
       x-amazon-apigateway-integration:
         <<: *ApiGatewayIntegration
-        uri: ${method_createDeviceReferenceData}
+        uri: ${method_searchDeviceReferenceData}
       security:
         - ${authoriser_name}: []
         - app-level0: []
@@ -239,6 +247,12 @@ paths:
   : post:
       operationId: createDeviceReferenceDataMessageSet
       summary: Create a Device Reference Data Message Set resource (POST)
+      description: |
+        This endpoint creates a Device Reference Data Message Set resource for the specified Product.
+        **Requirements:**
+        - A valid Product Team must exist
+        - A valid EPR Product must already exist under the Product Team
+        - There can be no existing MHS MessageSet DRD for the EPR Product already
       parameters:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/ProductId"
@@ -265,6 +279,12 @@ paths:
   : post:
       operationId: createDeviceReferenceDataAdditionalInteractions
       summary: Create a Device Reference Data Additional Interactions resource (POST)
+      description: |
+        This endpoint creates a Device Reference Data Additional Interactions resource for the specified Product.
+        **Requirements:**
+        - A valid Product Team must exist
+        - A valid EPR Product must already exist under the Product Team
+        - There can be no existing AS AdditionalInteractions DRD for the EPR Product already
       parameters:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/ProductId"
@@ -314,6 +334,8 @@ paths:
     post:
       operationId: createDevice
       summary: Create a Device resource (POST)
+      description: |
+        This endpoint has not yet been configured. Do not use.
       parameters:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/ProductId"
@@ -363,6 +385,14 @@ paths:
   : post:
       operationId: createDeviceMessageHandlingSystem
       summary: Create a Message Handling System Device resource (POST)
+      description: |
+        This endpoint creates a new Message Handling System Device resource for the specified Product.
+        **Requirements:**
+        - A valid Product Team must exist
+        - A valid Product must exist under the Product Team
+        - One existing MHS Message Set Device Reference Data must be present for the Product
+        - No existing MHS device for the product
+        - Must provide a spine_mhs questionnaire response
       parameters:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/ProductId"
@@ -389,6 +419,14 @@ paths:
     post:
       operationId: createDeviceAccreditedSystem
       summary: Create a Accredited System Device resource (POST)
+      description: |
+        This endpoint creates a new Accredited System Device resource for the specified Product.
+        **Requirements:**
+        - A valid Product Team must exist
+        - A valid Product must exist under the Product Team
+        - One existing MHS Message Set Device Reference Data must be present for the Product
+        - One existing AS Additional Interactions Device Reference Data must be present for the Product
+        - Must provide a spine_as questionnaire response
       parameters:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/ProductId"

infrastructure/swagger/12_components--responses.yaml

@@ -55,6 +55,8 @@ components:
                     message: "Require a 'spine_mhs' questionnaire response to create a MHS Device"
                   - code: "VALIDATION_ERROR"
                     message: "Not an EPR Product: Cannot create MHS device for product without exactly one Party Key"
+                  - code: "VALIDATION_ERROR"
+                    message: "Duplicate 'Interaction ID' provided: value '<INTERACTION ID>' occurs <N> times in the questionnaire response."
     SdsSearchDeviceBadRequest:
       description: searchSDSDevice Bad request
       content:

infrastructure/swagger/endpoints_requirements.png

@@ -67,6 +67,7 @@
     },
     "Map": {
       "Type": "Map",
+      "MaxConcurrency": 10,
       "ItemProcessor": {
         "ProcessorConfig": {
           "Mode": "INLINE"

infrastructure/terraform/per_workspace/modules/etl/sds/etl-diagram--bulk-transform-and-load.asl.json

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "connecting-party-manager"
-version = "2024.12.11"
+version = "2024.12.16"
 description = "Repository for the Connecting Party Manager API and related services"
 authors = ["NHS England"]
 license = "LICENSE.md"

pyproject.toml

@@ -10,8 +10,8 @@
 import boto3
 from etl_utils.constants import CHANGELOG_NUMBER, WorkerKey
 from etl_utils.io import pkl_dumps_lz4
-from sds.epr.bulk_create.bulk_load_fanout import FANOUT
 
+from etl.sds.tests.etl_test_utils.etl_state import _delete_objects_by_prefix
 from test_helpers.aws_session import aws_session
 from test_helpers.terraform import read_terraform_output
 
@@ -38,12 +38,9 @@ def main(changelog_number, workspace):
         s3_client.put_object(
             Bucket=etl_bucket, Key=WorkerKey.LOAD, Body=EMPTY_JSON_DATA
         )
-        for i in range(FANOUT):
-            s3_client.put_object(
-                Bucket=etl_bucket,
-                Key=f"{WorkerKey.LOAD}.{i}",
-                Body=pkl_dumps_lz4(EMPTY_JSON_DATA),
-            )
+        _delete_objects_by_prefix(
+            s3_client=s3_client, bucket=etl_bucket, key_prefix=f"{WorkerKey.LOAD}."
+        )
         s3_client.delete_object(Bucket=etl_bucket, Key=CHANGELOG_NUMBER)
 
     if changelog_number: