Locations Inside Prison API

Purpose

Provides and API to manage the locations inside a prison.

Getting Started

Running locally against dev services

This is straight-forward as authentication is delegated down to the calling services in dev environment. Environment variables to be set are as follows:

API_BASE_URL_OAUTH=https://sign-in-dev.hmpps.service.justice.gov.uk/auth
API_BASE_URL_PRISON=https://prison-api-dev.prison.service.justice.gov.uk
LOCATIONS_INSIDE_PRISON_API_CLIENT_ID=[choose a suitable hmpps-auth client]
LOCATIONS_INSIDE_PRISON_API_CLIENT_SECRET=

Start the database and other required services via docker-compose with:

docker compose -f docker-compose-local.yml up

Then run the API.

Architecture

Architecture decision records start here