ministryofjustice/hmpps-interventions-service

Business/domain interface for providing rehabilitation services to service users

HMPPS Interventions Service

Business/domain API to find, arrange and monitor an intervention for service users (offenders).

Quickstart

Please see the quickstart document.

For documentation about configuring one-off or scheduled jobs, see the components document.

Common tasks and runbooks are in the service's technical guidance.

Architecture

To see where this service fits in the broader interventions (and probation) architecture, you can browse the HMPPS C4 models here.

• Decisions specific to this application
• Decisions relevant to the "interventions" domain

Code Style

ktlint is the authority on style and is enforced on build.

Run ./gradlew ktlintFormat to fix formatting errors in your code before commit.

Resource documentation

• API: OpenAPI documentation is auto-generated. To view it start the application and visit /swagger-ui.html in your browser.
• Data: Data documentation is auto-generated. To view it, visit https://{dev}/meta/schema. It also generates an ERD at here.