From bf2fd7804bbec898802be06731ea618cb2ea3d25 Mon Sep 17 00:00:00 2001 From: Edd Almond Date: Tue, 24 Jun 2025 16:54:04 +0100 Subject: [PATCH 1/5] amending readmes post handover of sandbox deployment --- README.md | 3 ++- sandbox/README.md | 8 +++++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index d55eb91..7cdf8b8 100644 --- a/README.md +++ b/README.md @@ -49,7 +49,8 @@ The following software packages, or their equivalents, are expected to be instal - [Docker](https://www.docker.com/) container runtime or a compatible tool, e.g. [Podman](https://podman.io/), - [asdf](https://asdf-vm.com/) version manager, - [GNU make](https://www.gnu.org/software/make/) 3.82 or later, -- [npm](https://www.npmjs.com/) +- [npm](https://www.npmjs.com/) - Java version 17 or higher +- [gsed]() - for MacOS only > [!NOTE]
> The version of GNU make available by default on macOS is earlier than 3.82. You will need to upgrade it or certain `make` tasks will fail. On macOS, you will need [Homebrew](https://brew.sh/) installed, then to install `make`, like so: diff --git a/sandbox/README.md b/sandbox/README.md index f4d3250..f8679c9 100644 --- a/sandbox/README.md +++ b/sandbox/README.md @@ -31,6 +31,11 @@ There are a number of examples of responses which can be returned by passing spe curl -X GET "http://0.0.0.0:9000/patient-check/ ``` +or for sandbox: +```bash + curl -X GET "https://sandbox.api.service.nhs.uk/eligibility-signposting-api/patient-check/1" -H "accept: application/json" -H "apikey: g1112R_ccQ1Ebbb4gtHBP1aaaNM" +``` + #### Example scenarios | Patient ID | Response | @@ -66,4 +71,5 @@ Instructions for creation and deployment of the sandbox specification can be fou To deploy the sandbox Docker image to AWS ECR, we use Proxygen CLI as follows: 1. Run `make build-and-publish-sandbox-image` to build the sandbox image and publish to the docker ECR repository. -2. Run `make deploy-sandbox-spec` to build and publish the sandbox spec to the sandbox instance on APIM. +2. Run `proxygen instance deploy sandbox eligibility-signposting-api build/specification/sandbox/eligibility-signposting-api.yaml` + to build and publish the sandbox spec to the sandbox instance on APIM. From f9a6c60f1b448b5c8bb9b50fd5cdc11350c0961a Mon Sep 17 00:00:00 2001 From: Edd Almond Date: Tue, 24 Jun 2025 17:03:53 +0100 Subject: [PATCH 2/5] linting --- README.md | 2 +- sandbox/README.md | 1 + 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7cdf8b8..ad8a350 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ The following software packages, or their equivalents, are expected to be instal - [asdf](https://asdf-vm.com/) version manager, - [GNU make](https://www.gnu.org/software/make/) 3.82 or later, - [npm](https://www.npmjs.com/) - Java version 17 or higher -- [gsed]() - for MacOS only +- [gsed](https://www.gnu.org/software/sed/) - for MacOS only > [!NOTE]
> The version of GNU make available by default on macOS is earlier than 3.82. You will need to upgrade it or certain `make` tasks will fail. On macOS, you will need [Homebrew](https://brew.sh/) installed, then to install `make`, like so: diff --git a/sandbox/README.md b/sandbox/README.md index f8679c9..f608cb5 100644 --- a/sandbox/README.md +++ b/sandbox/README.md @@ -32,6 +32,7 @@ There are a number of examples of responses which can be returned by passing spe ``` or for sandbox: + ```bash curl -X GET "https://sandbox.api.service.nhs.uk/eligibility-signposting-api/patient-check/1" -H "accept: application/json" -H "apikey: g1112R_ccQ1Ebbb4gtHBP1aaaNM" ``` From cceabd93c3444a33b298b8f10bcae6ca9b07e45c Mon Sep 17 00:00:00 2001 From: Edd Almond Date: Tue, 24 Jun 2025 17:04:38 +0100 Subject: [PATCH 3/5] linting part 2 --- sandbox/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sandbox/README.md b/sandbox/README.md index f608cb5..fb80a06 100644 --- a/sandbox/README.md +++ b/sandbox/README.md @@ -34,7 +34,7 @@ There are a number of examples of responses which can be returned by passing spe or for sandbox: ```bash - curl -X GET "https://sandbox.api.service.nhs.uk/eligibility-signposting-api/patient-check/1" -H "accept: application/json" -H "apikey: g1112R_ccQ1Ebbb4gtHBP1aaaNM" + curl -X GET "https://sandbox.api.service.nhs.uk/eligibility-signposting-api/patient-check/1" -H "accept: application/json" -H "apikey: " ``` #### Example scenarios From d6c78e02a7e92c5662c3531b7ca5a9caffa58b98 Mon Sep 17 00:00:00 2001 From: Edd Almond Date: Tue, 24 Jun 2025 17:07:08 +0100 Subject: [PATCH 4/5] more linting --- sandbox/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/sandbox/README.md b/sandbox/README.md index fb80a06..72f16f7 100644 --- a/sandbox/README.md +++ b/sandbox/README.md @@ -31,10 +31,10 @@ There are a number of examples of responses which can be returned by passing spe curl -X GET "http://0.0.0.0:9000/patient-check/ ``` -or for sandbox: +or for sandbox (add a -H "apikey" to the request as well): ```bash - curl -X GET "https://sandbox.api.service.nhs.uk/eligibility-signposting-api/patient-check/1" -H "accept: application/json" -H "apikey: " + curl -X GET "https://sandbox.api.service.nhs.uk/eligibility-signposting-api/patient-check/1" -H "accept: application/json" ``` #### Example scenarios From ec65f85b5d44699de71a9f03fc4e8939f082e4bc Mon Sep 17 00:00:00 2001 From: Edd Almond Date: Tue, 24 Jun 2025 17:10:43 +0100 Subject: [PATCH 5/5] more linting --- .gitleaksignore | 1 + sandbox/README.md | 4 ++-- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/.gitleaksignore b/.gitleaksignore index cceb449..ab00afe 100644 --- a/.gitleaksignore +++ b/.gitleaksignore @@ -1,3 +1,4 @@ # SEE: https://github.com/gitleaks/gitleaks/blob/master/README.md#gitleaksignore cd9c0efec38c5d63053dd865e5d4e207c0760d91:docs/guides/Perform_static_analysis.md:generic-api-key:37 +bf2fd7804bbec898802be06731ea618cb2ea3d25:sandbox/README.md:generic-api-key:36 diff --git a/sandbox/README.md b/sandbox/README.md index 72f16f7..be5ab86 100644 --- a/sandbox/README.md +++ b/sandbox/README.md @@ -31,10 +31,10 @@ There are a number of examples of responses which can be returned by passing spe curl -X GET "http://0.0.0.0:9000/patient-check/ ``` -or for sandbox (add a -H "apikey" to the request as well): +or for sandbox: ```bash - curl -X GET "https://sandbox.api.service.nhs.uk/eligibility-signposting-api/patient-check/1" -H "accept: application/json" + curl -X GET "https://sandbox.api.service.nhs.uk/eligibility-signposting-api/patient-check/1" -H "accept: application/json" -H "apikey" ``` #### Example scenarios