diff --git a/projects/prison-case-notes-to-probation/README.md b/projects/prison-case-notes-to-probation/README.md index 04f582f594..2631f84911 100644 --- a/projects/prison-case-notes-to-probation/README.md +++ b/projects/prison-case-notes-to-probation/README.md @@ -11,7 +11,7 @@ used by probation practitioners as part of the probation case history ## Context Map -![Context Map](tech-docs/source/img/prison-case-notes-to-probation-context-map.png) +![Context Map](tech-docs/source/img/prison-case-notes-to-probation-context-map.svg) ## Interfaces diff --git a/projects/prison-case-notes-to-probation/tech-docs/diag/prison-case-notes-context-map.d2 b/projects/prison-case-notes-to-probation/tech-docs/diag/prison-case-notes-context-map.d2 new file mode 100644 index 0000000000..eb70b4f384 --- /dev/null +++ b/projects/prison-case-notes-to-probation/tech-docs/diag/prison-case-notes-context-map.d2 @@ -0,0 +1,46 @@ + +style { + fill: "#ffffff" +} + +context-nomis: Prisons/NOMIS Context { + + entities: Entities { + grid-columns: 3 + case-note: Case Note + offender: Person in Prison + location: Location + author: Author + } + + interface: Offender Case Notes API { + link: https://github.com/ministryofjustice/offender-case-notes + type: Open Host Service + } +} + +context-delius: Delius Context { + link: https://github.com/ministryofjustice/delius + style.stroke-width: 8 + + entities: Entities { + grid-columns: 3 + person-on-probation: Person on Probation + institution: Institution + probation-area: Probation Area + contact: Contact + staff: Staff + team: Team + + } + interface: Prison Case Notes to Probation { + link: https://github.com/ministryofjustice/hmpps-probation-integration-services/tree/main/projects/prison-case-notes-to-probation + type: Anti-Corruption Layer + } +} + +context-nomis.interface--context-delius.interface: Upstream\n\n\nDownstream + +*.style.border-radius: 10 +*.*.style.border-radius: 10 +*.*.style.stroke-width: 2 diff --git a/projects/prison-case-notes-to-probation/tech-docs/source/async-api-reference.html.md.erb b/projects/prison-case-notes-to-probation/tech-docs/source/async-api-reference.html.md.erb new file mode 100644 index 0000000000..74ba8b94f3 --- /dev/null +++ b/projects/prison-case-notes-to-probation/tech-docs/source/async-api-reference.html.md.erb @@ -0,0 +1,9 @@ +--- +title: AsyncAPI Reference +source_url: 'https://github.com/ministryofjustice/hmpps-probation-integration-services/blob/main/projects/prison-case-notes-to-probation/tech-docs/source/async-api-reference.html.md.erb' +weight: 30 +--- + +# ASyncAPI Reference + + diff --git a/projects/prison-case-notes-to-probation/tech-docs/source/img/prison-case-notes-to-probation-context-map.svg b/projects/prison-case-notes-to-probation/tech-docs/source/img/prison-case-notes-to-probation-context-map.svg new file mode 100644 index 0000000000..3d558dc92c --- /dev/null +++ b/projects/prison-case-notes-to-probation/tech-docs/source/img/prison-case-notes-to-probation-context-map.svg @@ -0,0 +1,166 @@ +Prisons/NOMIS ContextDelius ContextEntitiesOffender Case Notes APIEntitiesPrison Case Notes to ProbationCase NotePerson in PrisonLocationAuthorOpen Host ServicePerson on ProbationInstitutionProbation AreaContactStaffTeamAnti-Corruption LayerUpstream Downstream + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/projects/prison-case-notes-to-probation/tech-docs/spec/async-api.yaml b/projects/prison-case-notes-to-probation/tech-docs/spec/async-api.yaml new file mode 100644 index 0000000000..3a7cab50ef --- /dev/null +++ b/projects/prison-case-notes-to-probation/tech-docs/spec/async-api.yaml @@ -0,0 +1,23 @@ +asyncapi: 2.6.0 +info: + title: Prison Case Notes to Probation + description: Import Prison Case Notes to the Delius Contact Log + version: 0.1.0 + +servers: + development: + url: https://sqs.eu-west-2.amazonaws.com/754256621582/probation-integration-dev-prison-case-notes-to-probation-queue + protocol: sqs + preproduction: + url: https://sqs.eu-west-2.amazonaws.com/754256621582/probation-integration-preprod-prison-case-notes-to-probation-queue + protocol: sqs + production: + url: https://sqs.eu-west-2.amazonaws.com/754256621582/probation-integration-prod-prison-case-notes-to-probation-queue + protocol: sqs + +channels: + hmpps-domain-events/prison-case-notes-to-probation/prison.case-note.published: + subscribe: + operationId: prison.case-note.published + message: + $ref: https://raw.githubusercontent.com/ministryofjustice/hmpps-domain-events/main/spec/schemas/prison/case-note-published.yml