From cd557b8ff6437eec6306e41b71096feb48f060e6 Mon Sep 17 00:00:00 2001 From: popey2700 Date: Thu, 23 May 2024 16:29:33 +0100 Subject: [PATCH 1/2] Update diagrams --- docs/diagrams/container.puml | 4 ++-- docs/diagrams/context.puml | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/diagrams/container.puml b/docs/diagrams/container.puml index 167cc3eaf..26ca790ec 100644 --- a/docs/diagrams/container.puml +++ b/docs/diagrams/container.puml @@ -34,8 +34,8 @@ Boundary(aws_cloudplatform, "Cloud Platform", "A Kubernetes cluster using Amazon } Rel(consumer, spring_boot_api, "Makes API calls to", "JSON/HTTPS") -Rel(consumer, messaging, "Retrieves updates") -Rel_Right(spring_boot_api, messaging, "Posts updates") +Rel(messaging, consumer, "Retrieves updates") +Rel_Up(upstream, messaging, "Posts updates") Rel_Right(spring_boot_api, hmpps_auth, "Authenticates", "Bearer Token") Rel_Down(spring_boot_api, upstream, "Makes API calls to", "JSON/HTTPS") diff --git a/docs/diagrams/context.puml b/docs/diagrams/context.puml index a5bbe6a3c..999c93549 100644 --- a/docs/diagrams/context.puml +++ b/docs/diagrams/context.puml @@ -21,7 +21,7 @@ Boundary(moj, "Ministry of Justice (MOJ)", "Ministerial Department") { } Rel_Down(consumer, hmpps_integration_api, "Uses") -Rel_Right(hmpps_integration_api, messaging, "Posts updates") +Rel_Up(upstream, messaging, "Posts updates") Rel_Up(messaging, consumer, "Retrieves updates") Rel(hmpps_integration_api, upstream, "Queries for data") From 5bdef3c8f24ecb564920616b9adbbf4fff909dda Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Thu, 23 May 2024 15:30:12 +0000 Subject: [PATCH 2/2] Exported .PUML PlantUML diagrams to .SVG --- docs/diagrams/container.svg | 2 +- docs/diagrams/context.svg | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/diagrams/container.svg b/docs/diagrams/container.svg index be008d3c8..7f04df85f 100644 --- a/docs/diagrams/container.svg +++ b/docs/diagrams/container.svg @@ -1 +1 @@ -[Container] HMPPS Integration APICloud Platform[A Kubernetes cluster using Amazon Web Services]HMPPS Integration API[A single point of entry for services to retrieve data from multiple HMPPS systems.]Legacy Upstream Systems[Various HMPPS upstream systems, some of these will eventually be replaced]HMPPS Auth[Spring Boot Kotlin API] HMPPS Auth Server ForHMPPS Digital ServicesREST API[Spring Boot Kotlin API] Pulls data from upstreamsystems. Data is formattedinto standardised modelsMessaging System SNS/SQS Service.Prison API[Spring Boot Java API] API over NOMIS DB used byDigital Prison teamapplications and servicesProbation OffenderSearch[Springoot Kotlin API] API over the nDelius offenderdata held in ElasticsearchPrisoner Search[Spring Boot Kotlin API] API over the NOMIS prisonerdata held in OpenSearchOASys[Spring Boot Kotlin API] REST access to the OASysOracle DB offenderassessment informationAssess Risks andNeeds[Spring Boot Kotlin API] API over the Risks, Needsand Responsivity (RNR) datafor an offender held in theAssess Risks and NeedsServiceAdjudications[Spring Boot Kotlin API] Adjudications related to anoffenderCase Notes[Spring Boot Kotlin API] Case Notes related to anoffenderEPF and nDelius[Spring Boot Kotlin API]Create and VaryLicense[Spring Boot Kotlin API] Licenses related to anoffenderConsumer Application An authenticated consumerof the Integration API.Makes API calls to[JSON/HTTPS]Retrieves updatesPosts updatesAuthenticates[Bearer Token]Makes API calls to[JSON/HTTPS]Legend ▯ container ▯ external_system ▯ boundary(dashed) ▯ not_yet_implemented  \ No newline at end of file +[Container] HMPPS Integration APICloud Platform[A Kubernetes cluster using Amazon Web Services]HMPPS Integration API[A single point of entry for services to retrieve data from multiple HMPPS systems.]Legacy Upstream Systems[Various HMPPS upstream systems, some of these will eventually be replaced]HMPPS Auth[Spring Boot Kotlin API] HMPPS Auth Server ForHMPPS Digital ServicesREST API[Spring Boot Kotlin API] Pulls data from upstreamsystems. Data is formattedinto standardised modelsMessaging System SNS/SQS Service.Prison API[Spring Boot Java API] API over NOMIS DB used byDigital Prison teamapplications and servicesProbation OffenderSearch[Springoot Kotlin API] API over the nDelius offenderdata held in ElasticsearchPrisoner Search[Spring Boot Kotlin API] API over the NOMIS prisonerdata held in OpenSearchOASys[Spring Boot Kotlin API] REST access to the OASysOracle DB offenderassessment informationAssess Risks andNeeds[Spring Boot Kotlin API] API over the Risks, Needsand Responsivity (RNR) datafor an offender held in theAssess Risks and NeedsServiceAdjudications[Spring Boot Kotlin API] Adjudications related to anoffenderCase Notes[Spring Boot Kotlin API] Case Notes related to anoffenderEPF and nDelius[Spring Boot Kotlin API]Create and VaryLicense[Spring Boot Kotlin API] Licenses related to anoffenderConsumer Application An authenticated consumerof the Integration API.Makes API calls to[JSON/HTTPS]Retrieves updatesPosts updatesAuthenticates[Bearer Token]Makes API calls to[JSON/HTTPS]Legend ▯ container ▯ external_system ▯ boundary(dashed) ▯ not_yet_implemented  \ No newline at end of file diff --git a/docs/diagrams/context.svg b/docs/diagrams/context.svg index 0c756d007..8a2b3bf76 100644 --- a/docs/diagrams/context.svg +++ b/docs/diagrams/context.svg @@ -1 +1 @@ -[Context] HMPPS Integration APIMinistry of Justice (MOJ)[Ministerial Department]His Majesty's Prison and Probation Service (HMPPS)[Executive Agency]HMPPS IntegrationAPI A single point of entry forservices to retrieve data frommultiple HMPPS systems.Messaging System SNS/SQS Service.Upstream Systems Integrated systems wheredata is retrieved from.Consumer Application An authenticated consumerof the Integration API.UsesPosts updatesRetrieves updatesQueries for dataLegend ▯ system ▯ external_system ▯ boundary(dashed) ▯ not_yet_implemented  \ No newline at end of file +[Context] HMPPS Integration APIMinistry of Justice (MOJ)[Ministerial Department]His Majesty's Prison and Probation Service (HMPPS)[Executive Agency]HMPPS IntegrationAPI A single point of entry forservices to retrieve data frommultiple HMPPS systems.Messaging System SNS/SQS Service.Upstream Systems Integrated systems wheredata is retrieved from.Consumer Application An authenticated consumerof the Integration API.UsesPosts updatesRetrieves updatesQueries for dataLegend ▯ system ▯ external_system ▯ boundary(dashed) ▯ not_yet_implemented  \ No newline at end of file