hmpps-manage-users-api

A Spring Boot JSON API to manage the users. Backend services for https://github.com/ministryofjustice/hmpps-manage-users

Building

./gradlew build

Code style & formatting

./gradlew ktlintApplyToIdea addKtlintFormatGitPreCommitHook

will apply ktlint styles to intellij and also add a pre-commit hook to format all changed kotlin files.

Health

• /health/ping: will respond {"status":"UP"} to all requests. This should be used by dependent systems to check connectivity to hmpps-manage-users-api, rather than calling the /health endpoint.
• /health: provides information about the application health and its dependencies. This should only be used by hmpps-manage-users-api health monitoring (e.g. pager duty) and not other systems who wish to find out the state of hmpps-manage-users-api.
• /info: provides information about the version of deployed application.

Architecture

Architecture decision records start here

To Run all hmpps-auth related services

To Remove existing images

docker-compose stop && docker-compose -f docker-compose-full.yml down --rmi all

To run all services in docker-compose-full.yml

docker-compose pull &&  docker-compose -f docker-compose-full.yml up -d

Delius is configured as a mock service and responses are at 'wiremock/mappings/delius.json'