README.md

HMPPS Breach Notice API

API back-end for the HMPPS Breach Notice service.

Instructions

Running the application locally

The application comes with a dev spring profile that includes default settings for running locally. This is not necessary when deploying to kubernetes as these values are included in the helm configuration templates - e.g. values-dev.yaml.

There is also a docker-compose.yml that can be used to run a local instance of the template in docker and also an instance of HMPPS Auth (required if your service calls out to other services using a token).

docker compose pull && docker compose up

will build the application and run it and HMPPS Auth within a local docker instance.

Running the application in IntelliJ IDEA

docker compose pull && docker compose up --scale hmpps-breach-notice-api=0

will just start a docker instance of HMPPS Auth. The application should then be started with a dev active profile in IntelliJ.

Authentication

All API endpoints require an OAuth2 client token from HMPPS Auth with the BREACH_NOTICE role.

When running locally, there is a built-in client you can use that has the correct role:

CLIENT_ID=hmpps-breach-notice-ui-client
CLIENT_SECRET=clientsecret