Add sequence diagram section to docs/README; use PlantUML proxy to re…

…nder svg (#51) * Sequence diagrams linked in README; PlantUML proxy render for sequence diags Add Sequence Diagrams section to the Docs/README.md; create a new sequence diagram .md file for each sequence diagram referenced from README; incorporate PlantUML proxy service to render the sequence diagrams within each new sequence page. * Update PISPTransactionApi.puml Fix color names Co-authored-by: Paweł Marzec <[email protected]>
mojaloop · Mar 8, 2021 · ec9d504 · ec9d504
1 parent 1cd8a66
commit ec9d504
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 2 deletions.
diff --git a/docs/DFSPTransactionModelSeq.md b/docs/DFSPTransactionModelSeq.md
@@ -0,0 +1,5 @@
+## DFSP Transaction Model
+How a DFSP experiences a PISP transaction
+
+![](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/mojaloop/thirdparty-scheme-adapter/master/docs/sequence/DFSPTransactionModel.puml&fmt=svg)
+
diff --git a/docs/PISPTransactionAPISeq.md b/docs/PISPTransactionAPISeq.md
@@ -0,0 +1,5 @@
+# PISP Transaction API
+Example PISP Transaction
+
+![](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/mojaloop/thirdparty-scheme-adapter/master/docs/sequence/PISPTransactionApi.puml&fmt=svg)
+
diff --git a/docs/PISPTransactionModelSeq.md b/docs/PISPTransactionModelSeq.md
@@ -0,0 +1,5 @@
+# PISP Transaction Model
+How a PISP experiences a transaction
+
+![](http://www.plantuml.com/plantuml/proxy?cache=no&src=https://raw.githubusercontent.com/mojaloop/thirdparty-scheme-adapter/master/docs/sequence/PISPTransactionModel.puml&fmt=svg)
+
diff --git a/docs/README.md b/docs/README.md
@@ -11,7 +11,15 @@
 - Where external is for communication between the DFSP and the adapter
 - And internal is for communication between the adapter and the adapter
 
+## Sequence Diagrams
+[DFSP Transaction Model](./DFSPTransactionModelSeq.md)  
+How a DFSP experiences a PISP transaction
 
+[PISP Transaction Model](./PISPTransactionModelSeq.md)  
+How a PISP experiences a transaction
+
+[PISP Transaction API](./PISPTransactionAPISeq.md)  
+Example PISP Transaction
 
 ## TODO:
 

diff --git a/docs/sequence/PISPTransactionApi.puml b/docs/sequence/PISPTransactionApi.puml
@@ -30,7 +30,7 @@ participant "AUTH-SERVICE" as AUTHS
 
 == Party Lookup ==
 autonumber 1 "<b>LOOK-#</b>"
-rnote right of PISP #Light
+rnote right of PISP #LightBlue
 POST /thirdpartyTransactions
 {
   transactionRequestId: "12345",
@@ -71,7 +71,7 @@ deactivate PISP
 
 == Initate Transaction ==
 autonumber 1 "<b>INIT-#</b>"
-rnote right of PISP #Light
+rnote right of PISP #LightBlue
 POST /thirdpartyTransactions/{transactionRequestId}/initiate
 {
   sourceAccountId: "dfspa.alice.1234",
@@ -244,6 +244,7 @@ deactivate PISP
 
 == Approve Transaction ==
 autonumber 1 "<b>APPR-#</b>"
+rnote right of PISP #LightBlue
 rnote right of PISP #Light
 POST /thirdpartyTransactions/{id}/approve
 {