Fix swagger static and some typos

Author: francisco-videira-nhs

.devcontainer/devcontainer.json

@@ -76,6 +76,9 @@
       "installDockerComposeSwitch": true,
       "moby": true,
       "version": "latest"
+    },
+    "ghcr.io/devcontainers/features/dotnet:2.4.0": {
+      "version": "8.0"
     }
   },
   "mounts": [

.github/actions/build-sdk/action.yml

@@ -49,7 +49,6 @@ runs:
       run: |
         make build VERSION="${{ inputs.version }}"
 
-
     - name: Upload API OAS specification artifact
       uses: actions/upload-artifact@v4
       with:
@@ -86,13 +85,6 @@ runs:
         path: "sdk/csharp"
         name: sdk-csharp-${{ inputs.version }}
 
-    # - name: Upload artifact
-    #   # Automatically uploads an artifact from the './_site' directory by default
-    #   uses: actions/upload-pages-artifact@v3
-    #   with:
-    #     path: "docs/_site/"
-    #     name: jekyll-docs-${{ inputs.version }}
-
     - name: Upload artifact
       uses: actions/upload-pages-artifact@v3
       with:

.github/workflows/stage-5-publish.yaml

@@ -112,8 +112,7 @@ jobs:
           draft: false
           prerelease: ${{ inputs.is_version_prerelease == 'true'}}
 
-
-      - name: "Upload jeykll docs release asset"
+      - name: "Upload jekyll docs release asset"
         uses: actions/upload-release-asset@v1
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -143,7 +142,6 @@ jobs:
           asset_name: sdk-swagger-docs-${{ inputs.version }}.tar
           asset_content_type: "application/gzip"
 
-
       - name: "zip html release asset"
         # Git hub pages needs a single tar called artifact inside the zip.
         working-directory: ./artifacts/sdk-html-${{ inputs.version }}
@@ -192,9 +190,6 @@ jobs:
           asset_name: sdk-python-${{ inputs.version }}.zip
           asset_content_type: "application/gzip"
 
-
-
-
       - name: "zip sdk csharp release asset"
         # Git hub pages needs a single tar called artifact inside the zip.
         working-directory: ./artifacts/sdk-csharp-${{ inputs.version }}
@@ -227,7 +222,6 @@ jobs:
           asset_name: api-oas-specification-${{ inputs.version }}.zip
           asset_content_type: "application/gzip"
 
-
       - name: "zip csharp server release asset"
         # Git hub pages needs a single tar called artifact inside the zip.
         working-directory: ./artifacts/server-csharp-${{ inputs.version }}
@@ -244,8 +238,7 @@ jobs:
           asset_name: server-csharp-${{ inputs.version }}.zip
           asset_content_type: "application/gzip"
 
-
-### PUBLISH DOCKER  - THIS NEEDS CHANGING TO DO THE DOCKER BUILD IN THE BUILD STAGE AND ARTIFACT IT. SEE publishlibhostdocker below how how and the buildlibs action.
+  ### PUBLISH DOCKER  - THIS NEEDS CHANGING TO DO THE DOCKER BUILD IN THE BUILD STAGE AND ARTIFACT IT. SEE publishlibhostdocker below how how and the buildlibs action.
   publishdocker:
     name: "Publish docker packages"
     runs-on: ubuntu-latest
@@ -272,8 +265,7 @@ jobs:
         env:
           CR_PAT: ${{ secrets.GITHUB_TOKEN }}
 
-
-### PUBLISH NUGET
+  ### PUBLISH NUGET
   publishnuget:
     name: "Publish nuget packages to nuget.pkg.github.com"
     runs-on: ubuntu-latest
@@ -328,7 +320,7 @@ jobs:
           TEST_NUGET_VERSION: ${{ steps.set-nuget-version.outputs.TEST_NUGET_VERSION }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-### Publish NPM
+  ### Publish NPM
 
   publishnpm:
     name: "Publish npm packages to npm.pkg.github.com"
@@ -345,9 +337,9 @@ jobs:
           name: sdk-ts-${{ inputs.version }}
       - uses: actions/setup-node@v4
         with:
-          node-version: '24.3'
-          registry-url: 'https://npm.pkg.github.com'
-          scope: '@NHSDigital'
+          node-version: "24.3"
+          registry-url: "https://npm.pkg.github.com"
+          scope: "@NHSDigital"
 
       - run: ls -la
       - run: npm cache clear --force
@@ -358,9 +350,6 @@ jobs:
         env:
           NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-
-
-
       # - name: "Upload other release asset 1"
       #   uses: actions/upload-release-asset@v1
       #   env:
@@ -382,7 +371,7 @@ jobs:
   success:
     name: "Success notification"
     runs-on: ubuntu-latest
-    needs: [publish,publishnpm]
+    needs: [publish, publishnpm]
     steps:
       - name: "Check prerequisites for notification"
         id: check
@@ -397,8 +386,7 @@ jobs:
           message-text: "This is a notification body"
           link: ${{ github.event.pull_request.html_url }}
 
-
-### PUBLISH LIBS ABSTRACTION NUGET
+  ### PUBLISH LIBS ABSTRACTION NUGET
   publishlibsabstractionsnuget:
     name: "Publish libs abstractions packages to nuget.pkg.github.com"
     runs-on: ubuntu-latest
@@ -454,9 +442,7 @@ jobs:
           TEST_NUGET_VERSION: ${{ steps.set-nuget-version.outputs.TEST_NUGET_VERSION }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-
-
-### PUBLISH LIBS LETTERS NUGET
+  ### PUBLISH LIBS LETTERS NUGET
   publishliblettersnuget:
     name: "Publish libs letter packages to nuget.pkg.github.com"
     runs-on: ubuntu-latest
@@ -512,8 +498,7 @@ jobs:
           TEST_NUGET_VERSION: ${{ steps.set-nuget-version.outputs.TEST_NUGET_VERSION }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-
-### PUBLISH LIBS data NUGET
+  ### PUBLISH LIBS data NUGET
   publishlibhostnuget:
     name: "Publish libs data packages to nuget.pkg.github.com"
     runs-on: ubuntu-latest
@@ -569,9 +554,7 @@ jobs:
           TEST_NUGET_VERSION: ${{ steps.set-nuget-version.outputs.TEST_NUGET_VERSION }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-
-
-### PUBLISH LIBS host NUGET
+  ### PUBLISH LIBS host NUGET
   publishlibdatanuget:
     name: "Publish libs host packages to nuget.pkg.github.com"
     runs-on: ubuntu-latest
@@ -627,9 +610,7 @@ jobs:
           TEST_NUGET_VERSION: ${{ steps.set-nuget-version.outputs.TEST_NUGET_VERSION }}
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
-
-
-### PUBLISH LIBS host docker
+  ### PUBLISH LIBS host docker
   publishlibhostdocker:
     name: "Publish libs host docker"
     runs-on: ubuntu-latest

README.md

@@ -5,7 +5,7 @@
 
 The NHS Notify Supplier API is intended primarily for print suppliers to integrate with the NHS Notify message request queueing system.
 
-It models the concepts needed to configure production of letters and other printed materials to specific specifications, provide proofs of these materials, receive batch production requests, provide details of returned letters and correspondence, and to report on the status of these artifacts and associated management information such as volumes and assocated costs.
+It models the concepts needed to configure production of letters and other printed materials to specific specifications, provide proofs of these materials, receive batch production requests, provide details of returned letters and correspondence, and to report on the status of these artifacts and associated management information such as volumes and associated costs.
 
 This repository documents the Supplier API specification and provides an SDK with examples and reference client implementations for interacting with it.
 
@@ -25,8 +25,7 @@ This repository documents the Supplier API specification and provides an SDK wit
   - [SDK Assets](#sdk-assets)
   - [Examples](#examples)
 - [API Developers](#api-developers)
-  - [Documentation](#documentation-1)
-  - [pre built servers](#pre-built-servers)
+  - [Pre built servers](#pre-built-servers)
   - [Setup](#setup)
     - [Prerequisites and Configuration](#prerequisites-and-configuration)
       - [SDKs](#sdks)
@@ -71,15 +70,9 @@ TODO:CCM-11209 Links to example clients.
 
 ## API Developers
 
-New developer of the NHS Notify Supplier API
-should understand the below.
+New developer of the NHS Notify Supplier API should understand the below.
 
-### Documentation
-
-- [Built](/)
-- [Source](/docs/README.md)
-
-### pre built servers
+### Pre built servers
 
 - "Working" C# server [/src/server/host](/src/server/host) `docker run -p 8080:8080 ghcr.io/nhsdigital/libshostdocker:latest`
   - View at [http://localhost:8080/swagger/index.html](http://localhost:8080/swagger/index.html)
@@ -109,7 +102,7 @@ should understand the below.
 
 ##### Libs
 
-- [/src/server](/src/server) has various separate libaries that are used by:
+- [/src/server](/src/server) has various separate libraries that are used by:
   - [/src/server/host](/src/server/host) custom loads libs for different parts of the server
 
 ### Build

sdk/Makefile

@@ -8,6 +8,7 @@ build: version # Build the project artefact @Pipeline
 
 clean: # Clean-up project resources (main) @Operations
 	rm -rf */
+
 swagger:
 	./swagger.sh
 

sdk/swagger-initializer.js

@@ -3,7 +3,7 @@ window.onload = function() {
 
   // the following lines will be replaced by docker/configurator, when it runs in a docker-container
   window.ui = SwaggerUIBundle({
-    urls: [{url:"swagger.json", name: "current"}],
+    urls: [{url:"swagger.yml", name: "current"}],
     dom_id: '#swagger-ui',
     deepLinking: true,
     presets: [

sdk/swagger-static.sh

@@ -9,5 +9,5 @@ unzip swagger.zip "swagger-ui-$VERSION/dist/*" -d swagger
 mv swagger/swagger-ui-$VERSION/dist/* swagger
 rm -r swagger/swagger-ui-$VERSION
 cp swagger-initializer.js swagger/swagger-initializer.js
-cp ../specification/api/notify-supplier-phase1.yml swagger/swagger.json
+cp ../build/notify-supplier.yml swagger/swagger.yml
 rm swagger.zip

sdk/swagger.sh

@@ -1,3 +1,4 @@
 #!/bin/sh
+set -eux
 
-docker run -p 80:8080 -e SWAGGER_JSON=/swagger/swagger.json -v ../specification/api/notify-supplier.yml:/swagger/swagger.json docker.swagger.io/swaggerapi/swagger-ui
+docker run -p 80:8080 -e SWAGGER_JSON=/swagger/swagger.yml -v ../build/notify-supplier.yml:/swagger/swagger.yml docker.swagger.io/swaggerapi/swagger-ui

server/Makefile

@@ -7,8 +7,6 @@ build: version # Build the project artefact @Pipeline
 
 clean: # Clean-up project resources (main) @Operations
 	rm -rf */
-swagger:
-	./swagger.sh
 
 version:
 	touch _config.version.yml