Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

PI-1486: Update Prison Case Notes Documentation #2324

Merged
merged 1 commit into from
Sep 29, 2023
Merged

PI-1486: Update Prison Case Notes Documentation #2324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion projects/prison-case-notes-to-probation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
46 changes: 46 additions & 0 deletions projects/prison-case-notes-to-probation/tech-docs/diag/prison-case-notes-context-map.d2
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
9 changes: 9 additions & 0 deletions projects/prison-case-notes-to-probation/tech-docs/source/async-api-reference.html.md.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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

<iframe width="100%" onload="this.height=screen.height" frameborder=0 src="https://studio.asyncapi.com/?url=https://raw.githubusercontent.com/ministryofjustice/hmpps-probation-integration-services/main/projects/prison-case-notes-to-probation/tech-docs/spec/async-api.yaml&readOnly" title="ASync-API Spec"></iframe>
Loading