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/README.md b/README.md index d55eb91..ad8a350 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](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 f4d3250..be5ab86 100644 --- a/sandbox/README.md +++ b/sandbox/README.md @@ -31,6 +31,12 @@ 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" +``` + #### Example scenarios | Patient ID | Response | @@ -66,4 +72,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.