Skip to content

Commit ff27e33

Browse files
authored
Merge pull request #35 from NHSDigital/feature/update-make-commands-and-readme
amending readmes post handover of sandbox deployment
2 parents 9678329 + ec65f85 commit ff27e33

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

.gitleaksignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
# SEE: https://github.com/gitleaks/gitleaks/blob/master/README.md#gitleaksignore
22

33
cd9c0efec38c5d63053dd865e5d4e207c0760d91:docs/guides/Perform_static_analysis.md:generic-api-key:37
4+
bf2fd7804bbec898802be06731ea618cb2ea3d25:sandbox/README.md:generic-api-key:36

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ The following software packages, or their equivalents, are expected to be instal
4949
- [Docker](https://www.docker.com/) container runtime or a compatible tool, e.g. [Podman](https://podman.io/),
5050
- [asdf](https://asdf-vm.com/) version manager,
5151
- [GNU make](https://www.gnu.org/software/make/) 3.82 or later,
52-
- [npm](https://www.npmjs.com/)
52+
- [npm](https://www.npmjs.com/) - Java version 17 or higher
53+
- [gsed](https://www.gnu.org/software/sed/) - for MacOS only
5354

5455
> [!NOTE]<br>
5556
> 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:

sandbox/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ There are a number of examples of responses which can be returned by passing spe
3131
curl -X GET "http://0.0.0.0:9000/patient-check/<NHS_NUMBER>
3232
```
3333
34+
or for sandbox:
35+
36+
```bash
37+
curl -X GET "https://sandbox.api.service.nhs.uk/eligibility-signposting-api/patient-check/1" -H "accept: application/json" -H "apikey"
38+
```
39+
3440
#### Example scenarios
3541
3642
| Patient ID | Response |
@@ -66,4 +72,5 @@ Instructions for creation and deployment of the sandbox specification can be fou
6672
To deploy the sandbox Docker image to AWS ECR, we use Proxygen CLI as follows:
6773
6874
1. Run `make build-and-publish-sandbox-image` to build the sandbox image and publish to the docker ECR repository.
69-
2. Run `make deploy-sandbox-spec` to build and publish the sandbox spec to the sandbox instance on APIM.
75+
2. Run `proxygen instance deploy sandbox eligibility-signposting-api build/specification/sandbox/eligibility-signposting-api.yaml`
76+
to build and publish the sandbox spec to the sandbox instance on APIM.

0 commit comments

Comments
 (0)