Merge pull request #539 from NHSDigital/release/2025-03-12

jameslinnell · web-flow · commit 43a0a99fd017 · 2025-03-14T08:38:53.000Z
Release/2025 03 12
diff --git a/.sonarcloud.properties b/.sonarcloud.properties
@@ -1,3 +1 @@
-sonar.sources=.
-sonar.tests=.
 sonar.cpd.exclusions=src/api/**/index.py
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,12 @@
 # Changelog
 
+## 2025-03-12
+- [PI-841] Remove VPC cpm-sds-etl-hscn-vpc
+- [PI-851] Swagger spec refinement - Part Deux
+- [PI-854] Fix sonarcloud runs
+
 ## 2025-03-10
-- [PI-387] Add Product Team Id to search results
+- [PI-837] Add Product Team Id to search results
 - [PI-843] Add Read Product to test UI
 - [PI-764] Refine Swagger
 
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2025.03.10
+2025.03.12
diff --git a/archived_epr/infrastructure/terraform/per_account/modules/sds_etl_hscn_vpc/main.tf b/archived_epr/infrastructure/terraform/per_account/modules/sds_etl_hscn_vpc/main.tf
diff --git a/archived_epr/infrastructure/terraform/per_account/modules/sds_etl_hscn_vpc/vars.tf b/archived_epr/infrastructure/terraform/per_account/modules/sds_etl_hscn_vpc/vars.tf
diff --git a/changelog/2025-03-10.md b/changelog/2025-03-10.md
@@ -1,3 +1,3 @@
-- [PI-387] Add Product Team Id to search results
+- [PI-837] Add Product Team Id to search results
 - [PI-843] Add Read Product to test UI
 - [PI-764] Refine Swagger
diff --git a/changelog/2025-03-12.md b/changelog/2025-03-12.md
@@ -0,0 +1,3 @@
+- [PI-841] Remove VPC cpm-sds-etl-hscn-vpc
+- [PI-851] Swagger spec refinement - Part Deux
+- [PI-854] Fix sonarcloud runs
diff --git a/infrastructure/swagger/05_paths.yaml b/infrastructure/swagger/05_paths.yaml
@@ -122,6 +122,8 @@ paths:
       parameters:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/HeaderVersion"
+        - $ref: "#/components/parameters/HeaderAuthorization"
+        - $ref: "#/components/parameters/HeaderApikey"
         - $ref: "#/components/parameters/HeaderRequestId"
         - $ref: "#/components/parameters/HeaderCorrelationId"
       responses:
@@ -145,6 +147,8 @@ paths:
       parameters:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/HeaderVersion"
+        - $ref: "#/components/parameters/HeaderAuthorization"
+        - $ref: "#/components/parameters/HeaderApikey"
         - $ref: "#/components/parameters/HeaderRequestId"
         - $ref: "#/components/parameters/HeaderCorrelationId"
       responses:
@@ -171,7 +175,7 @@ paths:
         - $ref: "#/components/parameters/ProductTeamId"
       responses:
         "400":
-          $ref: "#/components/responses/BadRequest"
+          $ref: "#/components/responses/CreateProductBadRequest"
         "200":
           description: "200 response"
           headers:
@@ -243,7 +247,7 @@ paths:
         - Options
       responses:
         "400":
-          $ref: "#/components/responses/BadRequest"
+          $ref: "#/components/responses/SearchProductBadRequest"
         "200":
           description: "200 response"
           headers:
@@ -284,6 +288,8 @@ paths:
         - $ref: "#/components/parameters/ProductTeamIdQuery"
         - $ref: "#/components/parameters/OrganisationCodeQuery"
         - $ref: "#/components/parameters/HeaderVersion"
+        - $ref: "#/components/parameters/HeaderAuthorization"
+        - $ref: "#/components/parameters/HeaderApikey"
         - $ref: "#/components/parameters/HeaderRequestId"
         - $ref: "#/components/parameters/HeaderCorrelationId"
       responses:
@@ -307,8 +313,6 @@ paths:
       tags:
         - Options
       responses:
-        "400":
-          $ref: "#/components/responses/BadRequest"
         "200":
           description: "200 response"
           headers:
@@ -325,6 +329,8 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/Empty"
+        "400":
+          description: "400 response"
       x-amazon-apigateway-integration:
         responses:
           default:
@@ -350,6 +356,8 @@ paths:
       parameters:
         - $ref: "#/components/parameters/ProductId"
         - $ref: "#/components/parameters/HeaderVersion"
+        - $ref: "#/components/parameters/HeaderAuthorization"
+        - $ref: "#/components/parameters/HeaderApikey"
         - $ref: "#/components/parameters/HeaderRequestId"
         - $ref: "#/components/parameters/HeaderCorrelationId"
       responses:
@@ -374,8 +382,6 @@ paths:
       tags:
         - Options
       responses:
-        "400":
-          $ref: "#/components/responses/BadRequest"
         "200":
           description: "200 response"
           headers:
@@ -392,6 +398,8 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/Empty"
+        "404":
+          description: "404 response"
       x-amazon-apigateway-integration:
         responses:
           default:
@@ -418,6 +426,8 @@ paths:
         - $ref: "#/components/parameters/ProductTeamId"
         - $ref: "#/components/parameters/ProductId"
         - $ref: "#/components/parameters/HeaderVersion"
+        - $ref: "#/components/parameters/HeaderAuthorization"
+        - $ref: "#/components/parameters/HeaderApikey"
         - $ref: "#/components/parameters/HeaderRequestId"
         - $ref: "#/components/parameters/HeaderCorrelationId"
       responses:
diff --git a/infrastructure/swagger/07_components--schemas--domain.yaml b/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"
diff --git a/infrastructure/swagger/09_components--headers.yaml b/infrastructure/swagger/09_components--headers.yaml
@@ -22,10 +22,12 @@ components:
     HeaderAuthorization:
       in: header
       name: authorization
+      required: true
       schema:
         $ref: "#/components/schemas/HeaderAuthorization"
     HeaderApikey:
       in: header
       name: apikey
+      required: true
       schema:
         $ref: "#/components/schemas/HeaderApikey"
diff --git a/infrastructure/swagger/12_components--responses.yaml b/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:
diff --git a/infrastructure/terraform/per_account/dev/main.tf b/infrastructure/terraform/per_account/dev/main.tf
@@ -90,12 +90,6 @@ resource "aws_s3_bucket_logging" "truststore_to_access_logs" {
   target_prefix = "truststore/log/"
 }
 
-module "sds_etl_hscn_vpc" {
-  source      = "../modules/sds_etl_hscn_vpc"
-  environment = terraform.workspace
-  prefix      = local.project
-}
-
 # -------- ROUTE 53 ---------
 
 resource "aws_route53_zone" "dev-ns" {
diff --git a/infrastructure/terraform/per_account/int/main.tf b/infrastructure/terraform/per_account/int/main.tf
@@ -90,13 +90,6 @@ resource "aws_s3_bucket_logging" "truststore_to_access_logs" {
   target_prefix = "truststore/log/"
 }
 
-
-module "sds_etl_hscn_vpc" {
-  source      = "../modules/sds_etl_hscn_vpc"
-  environment = terraform.workspace
-  prefix      = local.project
-}
-
 # -------- ROUTE 53 ---------
 
 resource "aws_route53_zone" "int-ns" {
diff --git a/infrastructure/terraform/per_account/prod/main.tf b/infrastructure/terraform/per_account/prod/main.tf
@@ -90,12 +90,6 @@ resource "aws_s3_bucket_logging" "truststore_to_access_logs" {
   target_prefix = "truststore/log/"
 }
 
-module "sds_etl_hscn_vpc" {
-  source      = "../modules/sds_etl_hscn_vpc"
-  environment = terraform.workspace
-  prefix      = local.project
-}
-
 # -------- ROUTE 53 ---------
 
 resource "aws_route53_zone" "prod-ns" {
diff --git a/infrastructure/terraform/per_account/qa/main.tf b/infrastructure/terraform/per_account/qa/main.tf
@@ -90,12 +90,6 @@ resource "aws_s3_bucket_logging" "truststore_to_access_logs" {
   target_prefix = "truststore/log/"
 }
 
-module "sds_etl_hscn_vpc" {
-  source      = "../modules/sds_etl_hscn_vpc"
-  environment = terraform.workspace
-  prefix      = local.project
-}
-
 # -------- ROUTE 53 ---------
 
 resource "aws_route53_zone" "qa-ns" {
diff --git a/infrastructure/terraform/per_account/ref/main.tf b/infrastructure/terraform/per_account/ref/main.tf
@@ -90,12 +90,6 @@ resource "aws_s3_bucket_logging" "truststore_to_access_logs" {
   target_prefix = "truststore/log/"
 }
 
-module "sds_etl_hscn_vpc" {
-  source      = "../modules/sds_etl_hscn_vpc"
-  environment = terraform.workspace
-  prefix      = local.project
-}
-
 # -------- ROUTE 53 ---------
 
 resource "aws_route53_zone" "ref-ns" {
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "connecting-party-manager"
-version = "2025.03.10"
+version = "2025.03.12"
 description = "Repository for the Connecting Party Manager API and related services"
 authors = ["NHS England"]
 license = "LICENSE.md"
diff --git a/scripts/infrastructure/swagger/merge.sh b/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}

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1 @@`
`1`		`-sonar.sources=.`
`2`		`-sonar.tests=.`
`3`	`1`	`sonar.cpd.exclusions=src/api/**/index.py`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+- [PI-841] Remove VPC cpm-sds-etl-hscn-vpc`
	`2`	`+- [PI-851] Swagger spec refinement - Part Deux`
	`3`	`+- [PI-854] Fix sonarcloud runs`