Merge branch 'feature/PI-589-publish_swagger_fix' into release/2024-10-31

Author: megan-bower4

.github/workflows/_deploy.yml

@@ -152,8 +152,7 @@ jobs:
       - uses: actions/checkout@v4
         with:
           ref: ${{ needs.get-branch-from-workflow-file.outputs.branch_name }}
-      # change below to (env.ACCOUNT == 'int') || (env.ACCOUNT == 'prod') when ready for prod
-      - if: (${{ env.SCOPE == 'per_workspace'}}) && (${{ env.ACCOUNT == 'int' }})
+      - if: ${{ env.SCOPE == 'per_workspace' && env.ACCOUNT == 'int' }}
         uses: ./.github/actions/make/
         with:
           command: swagger--publish

.gitignore

@@ -77,7 +77,6 @@ dist
 .downloads
 openapi
 
-src/layers/domain/fhir/r4/*models.py
 postman-collection.json
 token_cache.json
 cpm.cdx.json

README.md

@@ -11,7 +11,7 @@
    4. [Other helpful commands](#other-helpful-commands)
 2. [Tests](#tests)
 3. [Workflow](#workflow)
-4. [FHIR, Swagger and FHIR Pydantic models](#fhir-swagger-and-fhir-pydantic-models)
+4. [Swagger](#swagger)
 5. [ETL](#etl)
 
 ---
@@ -257,9 +257,9 @@ This command will also:
 - Update the version in `pyproject.toml` with the release branch version.
 - Update the VERSION file with the release branch version number.
 
-## FHIR, Swagger and FHIR Pydantic models
+## Swagger
 
-This is all done by `make build`. For more details on how to update the Swagger and FHIR Pydantic models, please see [the swagger README](infrastructure/swagger/README.md).
+This is all done by `make build`. For more details on how to update the Swagger, please see [the swagger README](infrastructure/swagger/README.md).
 
 ## Setting Lambda permissions
 

docs/public_swagger/swagger.yaml

@@ -1,14 +1,3 @@
-# Fields from the autogenerated swagger to clear out
-servers: null
-info:
-  version: null
-  contact: null
-  title: null
-  description: null
-
-# Place fields not in the autogenerated swagger to the top of the file
+openapi: 3.0.3
 x-nhsd-apim:
 x-definitions:
-
-# Fields from the autogenerated swagger to "silence" for easier debugging
-x-ibm-configuration: null

infrastructure/swagger/00_base.yaml

@@ -1,8 +1,8 @@
 ---
 servers:
-  - url: https://sandbox.api.service.nhs.uk/connecting-party-manager/FHIR/R4
+  - url: https://sandbox.api.service.nhs.uk/connecting-party-manager
     description: Sandbox environment.
-  - url: https://int.api.service.nhs.uk/connecting-party-manager/FHIR/R4
+  - url: https://int.api.service.nhs.uk/connecting-party-manager
     description: Integration test environment.
-  - url: https://api.service.nhs.uk/connecting-party-manager/FHIR/R4
+  - url: https://api.service.nhs.uk/connecting-party-manager
     description: Production environment.

infrastructure/swagger/01_servers.yaml

@@ -1,7 +1,7 @@
 ---
 info:
   version: 1.0.0
-  title: Connecting Party Manager - FHIR API
+  title: Connecting Party Manager
   contact:
     name: NHS Digital API Management
     url: "https://digital.nhs.uk/developer/help-and-support"
@@ -36,20 +36,6 @@ info:
 
     This API is [RESTful](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#basic-rest).
 
-    It conforms to the [FHIR](https://digital.nhs.uk/developer/guides-and-documentation/our-api-technologies#fhir) global standard for health care data exchange, specifically to [FHIR R4 (v4.0.1)](https://hl7.org/fhir/r4/), except that it does not support the [capabilities](http://hl7.org/fhir/R4/http.html#capabilities) interaction.
-
-    It includes some country-specific FHIR extensions, which conform to [FHIR UK Core](https://digital.nhs.uk/services/fhir-uk-core), specifically [fhir.r4.ukcore.stu1 0.5.1](https://simplifier.net/packages/fhir.r4.ukcore.stu1/0.5.1).
-
-    You do not need to know much about FHIR to use this API - FHIR APIs are just RESTful APIs that follow specific rules.
-
-    In particular:
-
-    * resource names are capitalised and singular, and use US spellings, for example `Organization` not `organisations`
-    * array names are singular, for example `entry` not `entries` for address lines
-    * data items that are country-specific and thus not included in the FHIR global base resources are usually wrapped in an `extension` object
-
-    There are [libraries and SDKs available](https://digital.nhs.uk/developer/guides-and-documentation/api-technologies-at-nhs-digital#fhir-libraries-and-sdks) to help with FHIR API integration.
-
     ## Network access
 
     This API is available on the internet and, indirectly, on the [Health and Social Care Network (HSCN)](https://digital.nhs.uk/services/health-and-social-care-network).
@@ -87,9 +73,9 @@ info:
 
     | Environment       | Base URL                                                                    |
     | ----------------- | --------------------------------------------------------------------------- |
-    | Sandbox           | `https://sandbox.api.service.nhs.uk/connecting-party-manager/FHIR/R4/`      |
-    | Integration       | `https://int.api.service.nhs.uk/connecting-party-manager/consumer/FHIR/R4/` |
-    | Production        | `https://api.service.nhs.uk/connecting-party-manager/consumer/FHIR/R4/`     |
+    | Sandbox           | `https://sandbox.api.service.nhs.uk/connecting-party-manager/`      |
+    | Integration       | `https://int.api.service.nhs.uk/connecting-party-manager/consumer/` |
+    | Production        | `https://api.service.nhs.uk/connecting-party-manager/consumer/`     |
 
     ### Sandbox and Integration environments
 

infrastructure/swagger/02_info.yaml

@@ -1,5 +1,4 @@
 ---
-openapi: 3.0.3
 x-nhsd-apim:
   temporary: ${ terraform_output("workspace_type.value") != "PERSISTENT" }
   access: