Skip to content

amending readmes post handover of sandbox deployment #35

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
eddalmond1 merged 5 commits into from
Jun 24, 2025
Merged

amending readmes post handover of sandbox deployment #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
bf2fd78
amending readmes post handover of sandbox deployment
eddalmond1 Jun 24, 2025
f9a6c60
linting
eddalmond1 Jun 24, 2025
cceabd9
linting part 2
eddalmond1 Jun 24, 2025
d6c78e0
more linting
eddalmond1 Jun 24, 2025
ec65f85
more linting
eddalmond1 Jun 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitleaksignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]<br>
> 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:
Expand Down
9 changes: 8 additions & 1 deletion sandbox/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/<NHS_NUMBER>
```

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 |
Expand Down Expand Up @@ -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.
Loading