Trying the npm publish.

Author: RossBugginsNHS

.devcontainer/devcontainer.json

@@ -9,6 +9,7 @@
     },
     "vscode": {
       "extensions": [
+        "42crunch.vscode-openapi",
         "alefragnani.bookmarks",
         "AmazonWebServices.aws-toolkit-vscode",
         "chdsbd.github-code-owners",

.devcontainer/devcontainer_copy.json

@@ -43,6 +43,12 @@ runs:
       shell: bash
       run: make build
 
+    - name: Upload API OAS specification artifact
+      uses: actions/upload-artifact@v4
+      with:
+        path: "specification/api"
+        name: api-oas-specification-${{ inputs.version }}
+
     - name: Upload html artifact
       uses: actions/upload-artifact@v4
       with:

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

@@ -146,6 +146,41 @@ jobs:
           asset_name: sdk-python-${{ inputs.version }}.zip
           asset_content_type: "application/gzip"
 
+      - name: "Upload api OAS specification release asset"
+        uses: actions/upload-release-asset@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          upload_url: "${{ steps.create_release.outputs.upload_url }}"
+          asset_path: ./artifacts/api-oas-specification-${{ inputs.version }}.zip
+          asset_name: api-oas-specification-${{ inputs.version }}.zip
+          asset_content_type: "application/gzip"
+
+
+### Publish NPM
+
+  publishnpm:
+    name: "Publish npm packages to npm.pkg.github.com"
+    runs-on: ubuntu-latest
+    steps:
+      - name: "Get the artefacts"
+        uses: actions/download-artifact@v4
+        with:
+          path: ./artifacts
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          registry-url: 'https://npm.pkg.github.com'
+
+      - run: npm ci
+        working-directory: ./artifacts/sdk-ts-${{ inputs.version }}
+      - run: npm publish
+        working-directory: ./artifacts/sdk-ts-${{ inputs.version }}
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+
+
 
       # - name: "Upload other release asset 1"
       #   uses: actions/upload-release-asset@v1

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

@@ -19,23 +19,44 @@ This repository documents the Supplier API specification and provides an SDK wit
 - [NHS Notify Supplier API](#nhs-notify-supplier-api)
   - [OAS Specifications](#oas-specifications)
   - [Table of Contents](#table-of-contents)
-  - [Documentation](#documentation)
-  - [Setup](#setup)
-    - [Prerequisites and Configuration](#prerequisites-and-configuration)
-  - [Build](#build)
-  - [GitHub Actions CI/CD](#github-actions-cicd)
-    - [CI (Automatic)](#ci-automatic)
-    - [CD (Manual)](#cd-manual)
+  - [API Consumers - Getting Started](#api-consumers---getting-started)
+  - [API Developers](#api-developers)
+    - [Documentation](#documentation)
+    - [Setup](#setup)
+      - [Prerequisites and Configuration](#prerequisites-and-configuration)
+    - [Build](#build)
+    - [GitHub Actions CI/CD](#github-actions-cicd)
+      - [CI (Automatic)](#ci-automatic)
+      - [CD (Manual)](#cd-manual)
   - [Licence](#licence)
 
-## Documentation
+## API Consumers - Getting Started
+
+- View the [latest SDK documentation](https://nhsdigital.github.io/nhs-notify-supplier-api/)
+- Download SDKs from the [latest releases](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)
+  - Python `sdk-python-[Version].zip`
+  - TypeScript `sdk-ts-[Version].zip`
+- Download the OAS Specification File from the [latest releases](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)
+  - OAS JSON files `api-oas-specification-[Version].zip`
+- Download local versions of the API docs from the [latest releases](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)
+  - HTML `sdk-html-[Version].zip`
+  - Swagger `sdk-swagger-[Version].zip`
+
+TODO: Links to example clients.
+
+## API Developers
+
+New developer of the NHS Notify Supplier API
+should understand the below.
+
+### Documentation
 
 - [Built](/)
 - [Source](/docs/README.md)
 
-## Setup
+### Setup
 
-### Prerequisites and Configuration
+#### Prerequisites and Configuration
 
 - Utilised the devcontainer, for pre reqs and configuration.
 - You should open in a devcontainer or a Github workspaces.
@@ -46,7 +67,7 @@ This repository documents the Supplier API specification and provides an SDK wit
   and will be built as part of the CI/CD pipeline and released as a GitHub
   release.
 
-## Build
+### Build
 
 To generate the SDK folder from changes to the [specification/api/notify-supplier.yml](specification/api/notify-supplier.yml) OAS specification:
 
@@ -71,9 +92,9 @@ by default they will be available at [http://localhost:3050](http://localhost:30
 
 These are generated using [https://hub.docker.com/r/openapitools/openapi-generator-cli](https://hub.docker.com/r/openapitools/openapi-generator-cli)
 
-## GitHub Actions CI/CD
+### GitHub Actions CI/CD
 
-### CI (Automatic)
+#### CI (Automatic)
 
 PRs will run the [CI workflow](https://github.com/NHSDigital/nhs-notify-supplier-api/actions/workflows/cicd-1-pull-request.yaml)
 for testing.
@@ -83,7 +104,7 @@ will generate a
 [pre-release](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)
 based on the date and the commit hash.
 
-### CD (Manual)
+#### CD (Manual)
 
 Deployments can be made of any [release](https://github.com/NHSDigital/nhs-notify-supplier-api/releases)
 (including the GitHub pages) by running the CD pipeline

README.md

@@ -89,6 +89,7 @@
   },
   "extensions": {
     "recommendations": [
+  "42crunch.vscode-openapi",
   "alefragnani.bookmarks",
   "AmazonWebServices.aws-toolkit-vscode",
   "chdsbd.github-code-owners",

project.code-workspace

@@ -1,4 +1,4 @@
-openapi: 3.1.0
+openapi: 3.1.1
 info:
   version: next
   title: NHS Notify Supplier API
@@ -414,7 +414,8 @@ paths:
         - whitemail
       x-stoplight:
         id: lmbg85kro8iwy
-  /data:
+
+  '/data':
     parameters:
       - $ref: '#/components/parameters/requestId'
       - $ref: '#/components/parameters/correlationId'
@@ -423,19 +424,17 @@ paths:
       operationId: post-data
       tags:
         - data
+
+  '/data2/{id}':
+    parameters:
+      - $ref: '#/components/parameters/id'
+    get:
+      operationId: getdata2
+
   '/data/{id}':
     parameters:
-      - schema:
-          type: string
-        name: id
-        in: path
-        required: true
-      - name: id
-        in: path
-        description: Unique identifier of this resource
-        required: true
-        schema:
-          type: string
+      - $ref: '#/components/parameters/id'
+
       - name: X-Request-ID
         in: header
         description: 'Unique request identifier, in the format of a GUID'
@@ -444,6 +443,7 @@ paths:
           type: string
           examples:
             - dcb9c8dc-c2f4-4d5f-8674-a2e913e040b2
+
       - name: X-Correlation-ID
         in: header
         description: |-
@@ -462,6 +462,8 @@ paths:
       x-stoplight:
         id: 98lwlebl1vxeq
       responses:
+        '404':
+          description: Not Found
         '303':
           description: See Other
           headers:
@@ -473,7 +475,9 @@ paths:
       summary: Fetch data file metadata
       tags:
         - data
-      responses: {}
+      responses:
+        200:
+          description: OK
       operationId: head-data-id
       x-stoplight:
         id: tdjs72iaaavub
@@ -500,8 +504,8 @@ components:
         examples:
           - 11C46F5F-CDEF-4865-94B2-0EE0EDCC26DA
     id:
-      name: id
       in: path
+      name: id
       description: Unique identifier of this resource
       required: true
       schema: