Updates as per feedback received on issue #10. (#45)

HenkKodde · Sam · web-flow · commit f8a5daf102bb · 2020-02-11T10:32:46.000+02:00
* - Updated version to 8.6.3 - Create Encryption document in Markdown format - Added new Encryption document to SUMMARY.md for publishing. * - Included package-lock.json * - Converted the following documents in Markdown format; - JSON Binding Rules, - Generic Transaction Patterns. - Created the following sequence diagrams required in the documents; - figure63a.plantuml, - figure64a.plantuml, - figure65a.plantuml, - figure66a.plantuml. - Updated the following sequence diagrams; - figure63.plantuml, - figure64.plantuml, - figure65.plantuml, - figure66.plantuml. Increase version to 8.8.1 * Format updates to accommodate auto numbering and Gitbooks display format. Version to 8.8.1. * Example on lifeline deactivation and activation (PayerFSP -> PayerFSP). * Updated as per feedback received for issue #10. • Fixed - 5.1.6.9 ATM-Initiated Cash-Out** <-- two stars (*) after section name • Fixed - two delays added in Figure 34, between "Payer fee is 1 USD in Payer FSP for ATM Cash-Out, total fee 2 USD" and "OTP is pre-generated", and similarly between "Validate OTP sent by Payee FSP, OTP OK" and "Reserve 102 USD from Payer account, 101 USD to Switch account, 1 USD to fee account". There should not be any delays. This seems to be present in other figures as well (for example Figure 36, 46, 51, 52, 66). • Fixed - Some extra white space in at least Figure 34 and 36 in "PUT /transfers/" between the "PUT /transfers/" and "". • Fixed - Misspelling in Figure 36, "Generated OTP, "12345"" should be "Generate OTP, "12345"" • Fixed - Listing 12 is strange with double * instead of bold. • Fixed - 6.3.4.1, "Alternative URI: PUT /parties/{Type}/{ID}/{SubId}/error**" <-- double * • Fixed - 7.2.3.1 Regular Expression** <-- double ** • Fixed - 7.2.4.1 Regular Expression** <-- double ** • Fixed - 7.2.5.1 Regular Expression** <-- double ** Co-authored-by: Sam <elnyry@users.noreply.github.com>
diff --git a/assets/diagrams/sequence/figure1.plantuml b/assets/diagrams/sequence/figure1.plantuml
@@ -64,5 +64,6 @@ FSP <<- Switch: **PUT /service/**//<ID>//\n(Service object information)
 FSP -->> Switch: **HTTP 200** (OK)
 deactivate Switch
 FSP -> FSP: Handle service object information
-' deactivate FSP
+FSP -[hidden]> Switch
+deactivate FSP
 @enduml
diff --git a/assets/diagrams/sequence/figure2.plantuml b/assets/diagrams/sequence/figure2.plantuml
@@ -64,5 +64,6 @@ FSP <<- Switch: **PUT /service/**//<ID>//\n(Service object information)
 FSP -->> Switch: **HTTP 200** (OK)
 deactivate Switch
 FSP -> FSP: Handle service object\ninformation update
-' deactivate FSP
+FSP -[hidden]> FSP
+deactivate FSP
 @enduml
diff --git a/assets/diagrams/sequence/figure34.plantuml b/assets/diagrams/sequence/figure34.plantuml
@@ -155,7 +155,10 @@ Switch ->> PayerFSP: **PUT /quotes/**<i><ID></i>\n(transferAmount=101 USD,\npaye
 Switch <<-- PayerFSP: **HTTP 200** (OK)
 deactivate Switch
 PayerFSP -> PayerFSP: Payer fee is 1 USD in Payer FSP\nfor ATM Cash-Out, total fee 2 USD
-...
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
+PayerFSP -[hidden]> Switch
+activate PayerFSP
 PayerFSP -> PayerFSP: OTP is pre-generated
 Payer <<- PayerFSP: Use you pre-generated OTP to accept\ntransaction of 100 USD, 2 USD\nin fees.
 PayerFSP ->> Switch: **GET /authorizations/**\n<i>{TransactionRequestID}</i>/\n(amount=100 USD, fees=2 USD,\nretriesLeft=2, type=OTP)
@@ -175,7 +178,10 @@ PayerFSP <<- Switch: **PUT /authorizations/**\n<i>{transactionRequestID}</i>\n(o
 PayerFSP -->> Switch: **HTTP 200** (OK)
 deactivate Switch
 PayerFSP -> PayerFSP: Validate OTP sent by Payee FSP,\nOTP OK
-...
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
+PayerFSP -[hidden]> Switch
+activate PayerFSP
 PayerFSP -> PayerFSP: Reserve 102 USD from Payer\naccount, 101 USD to Switch\naccount, 1 USD to fee account
 PayerFSP ->> Switch: **POST /transfers**\n(amount=101 USD)
 activate Switch
@@ -187,11 +193,11 @@ Switch <<-- PayeeFSP: **HTTP 202** (Accepted)
 PayeeFSP -> PayeeFSP: Transfer 101 USD from Switch\naccount, 100 USD to Payee,\n1 USD to fee account
 PayeeFSP ->> PayeeATM: Dispense 100 USD in Cash
 PayeeATM ->> PayerOTC: Here is your 100 USD in cash
-Switch <<- PayeeFSP: **PUT /transfers/** <i><ID></i>
+Switch <<- PayeeFSP: **PUT /transfers/**<i><ID></i>
 Switch -->> PayeeFSP: **HTTP 200** (OK)
 deactivate PayeeFSP
 Switch <- Switch: Commit reserved transfer
-Switch ->> PayerFSP: **PUT /transfers/** <i><ID></i>
+Switch ->> PayerFSP: **PUT /transfers/**<i><ID></i>
 Switch <<-- PayerFSP: **HTTP 200** (OK)
 deactivate Switch
 PayerFSP <- PayerFSP: Commit reserved transfer
diff --git a/assets/diagrams/sequence/figure36.plantuml b/assets/diagrams/sequence/figure36.plantuml
@@ -150,8 +150,11 @@ Switch ->> PayerFSP: **PUT /quotes/**<i><ID></i>\n(transferAmount=99 USD,\npayee
 Switch <<-- PayerFSP: **HTTP 200** (OK)
 deactivate Switch
 PayerFSP -> PayerFSP: Payer FSP uses the\nFSP commission as\na transaction fee
-...
-PayerFSP -> PayerFSP: Generated OTP, "12345"
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
+PayerFSP -[hidden]> Switch
+activate PayerFSP
+PayerFSP -> PayerFSP: Generate OTP, "12345"
 Payer <<- PayerFSP: Use OTP "12345" to accept\ntransaction to Merchant of 100 USD,\n0 USD in fees.
 PayerFSP ->> Switch: **GET /authorizations/**\n<i>{TransactionRequestID}</i>/\n(amount=100 USD, fees=0 USD,\nretriesLeft=2, type=OTP)
 PayerFSP <<-- Switch: **HTTP 202** (Accepted)
@@ -166,7 +169,10 @@ Switch -->> PayeeFSP: **HTTP 200** (OK)
 PayerFSP <<- Switch: **PUT /authorizations/***\n<i>{transactionRequestID}</i>\n(otp="12345")
 PayerFSP -->> Switch: **HTTP 200** (OK)
 PayerFSP -> PayerFSP: Validate OTP sent by Payee FSP,\nOTP OK
-...
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
+PayerFSP -[hidden]> Switch
+activate PayerFSP
 PayerFSP -> PayerFSP: Reserve 100 USD from Payer\naccount, 99 USD to Switch\naccount, 1 USD to fee account
 PayerFSP ->> Switch: **POST /transfers**\n(amount=99 USD)
 activate Switch
@@ -178,11 +184,11 @@ Switch <<-- PayeeFSP: **HTTP 202** (Accepted)
 PayeeFSP -> PayeeFSP: Transfer 99 USD from Switch\naccount, 1 USD from\ncommission account\nto Payee account
 PayeeFSP ->> PayeePOS: You have received 100 USD\nfrom Payer. Please give goods\nor service to Payer.
 PayeePOS ->> PayerOTC: Here is your goods or service
-Switch <<- PayeeFSP: **PUT /transfers/** <i><ID></i>
+Switch <<- PayeeFSP: **PUT /transfers/**<i><ID></i>
 Switch -->> PayeeFSP: **HTTP 200** (OK)
 deactivate PayeeFSP
 Switch <- Switch: Commit reserved transfer
-Switch ->> PayerFSP: **PUT /transfers/** <i><ID></i>
+Switch ->> PayerFSP: **PUT /transfers/**<i><ID></i>
 Switch <<-- PayerFSP: **HTTP 200** (OK)
 deactivate Switch
 PayerFSP <- PayerFSP: Commit reserved transfer
diff --git a/assets/diagrams/sequence/figure40.plantuml b/assets/diagrams/sequence/figure40.plantuml
@@ -135,4 +135,6 @@ userfsp <<- fsp2: **PUT /participant/MSISDN/123456789/error**
 userfsp -->> fsp2: **HTTP 200** (OK)
 deactivate fsp2
 userfsp -> userfsp: +123456789 found\nin FSP 2
+userfsp -[hidden]>fsp2
+deactivate userfsp
 @enduml
diff --git a/assets/diagrams/sequence/figure43.plantuml b/assets/diagrams/sequence/figure43.plantuml
@@ -133,4 +133,6 @@ Switch ->> payeefsp: **PUT /transactionRequest/**<i><ID></i>\n(Received status)
 Switch <<-- payeefsp: **HTTP 200** (OK)
 deactivate Switch
 payeefsp -> payeefsp: Wait for either quote and\ntransfer, or rejected\ntransaction request by Payer
+payeefsp <[hidden]- payeefsp
+deactivate payeefsp
 @enduml
diff --git a/assets/diagrams/sequence/figure46.plantuml b/assets/diagrams/sequence/figure46.plantuml
@@ -120,7 +120,10 @@ actor "<$actor>\nPayee" as Payee
 Payer ->> PayerFSP: I would like to pay 100 USD\nto +123456789
 activate PayerFSP
 PayerFSP -> PayerFSP: Lookup +123456789\n(process not shown here)
-...
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
+PayerFSP -[hidden]> Switch
+activate PayerFSP
 PayerFSP -> PayerFSP: Rate Payer FSP quote\n(depending on fee model)
 PayerFSP ->> Switch: **POST /quotes/**\n(Transaction details)
 activate Switch
diff --git a/assets/diagrams/sequence/figure48.plantuml b/assets/diagrams/sequence/figure48.plantuml
@@ -152,4 +152,6 @@ PayerFSP <<- Switch: **PUT /authorizations/**\n<i><TransactionRequestID></i>\n(O
 PayerFSP -->> Switch: **HTTP 200** (OK)
 deactivate Switch
 PayerFSP -> PayerFSP: Validate OTP sent by Payee FSP
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
 @enduml
diff --git a/assets/diagrams/sequence/figure49.plantuml b/assets/diagrams/sequence/figure49.plantuml
@@ -141,4 +141,6 @@ deactivate Switch
 PayerFSP -> PayerFSP: Resend OTP (optionally\nregenerate) as customer\ndid not receive it
 Payer <<- PayerFSP: Use OTP "12345" to accept\ntransaction to Merchant\nof 100 USD,\n0 USD in fees.
 PayerFSP -> PayerFSP: Resend GET /authorizations\n(not shown here)
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
 @enduml
diff --git a/assets/diagrams/sequence/figure50.plantuml b/assets/diagrams/sequence/figure50.plantuml
@@ -156,4 +156,6 @@ PayerFSP <<- Switch: **PUT /autorizations/**\n<i><TransactionRequestID></i>\n(ot
 PayerFSP -->> Switch: **HTTP 200** (OK)
 deactivate Switch
 PayerFSP -> PayerFSP: Validates OTP sent by\nPayee FSP, OTP OK, perform\ntransfer (not shown here)
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
 @enduml
diff --git a/assets/diagrams/sequence/figure51.plantuml b/assets/diagrams/sequence/figure51.plantuml
@@ -120,10 +120,20 @@ actor "<$actor>\nPayee" as Payee
 Payer ->> PayerFSP: I would like to pay 100 USD\nto +123456789
 activate PayerFSP
 PayerFSP -> PayerFSP: Lookup +123456789\n(process not shown here)
-...
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
+PayerFSP -[hidden]> Switch
+activate PayerFSP
 PayerFSP -> PayerFSP: Quote\n(process not shown here)
-...
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
+PayerFSP -[hidden]> Switch
+activate PayerFSP
 PayerFSP -> PayerFSP: Reserve transfer from Payer\naccount to Switch account
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
+PayerFSP -[hidden]> Switch
+activate PayerFSP
 PayerFSP ->> Switch: **POST /transfers**\n(Transfer ID, conditions, ILP Packet\nincluding transaction details,\nexpiry=30 seconds)
 activate Switch
 PayerFSP <<-- Switch: **HTTP 202** (Accepted)
diff --git a/assets/diagrams/sequence/figure52.plantuml b/assets/diagrams/sequence/figure52.plantuml
@@ -120,9 +120,15 @@ actor "<$actor>\nPayee" as Payee
 Payer ->> PayerFSP: I would like to pay 100 USD\nto +123456789
 activate PayerFSP
 PayerFSP -> PayerFSP: Lookup +123456789\n(process not shown here)
-...
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
+PayerFSP -[hidden]> Switch
+activate PayerFSP
 PayerFSP -> PayerFSP: Quote\n(process not shown here)
-...
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
+PayerFSP -[hidden]> Switch
+activate PayerFSP
 PayerFSP -> PayerFSP: Reserve transfer from Payer\naccount to Switch
 PayerFSP ->> Switch: **POST /transfers**\n(Transfer ID, condition, ILP Packet\nincluding transaction details,\nexpiry=30 seconds)
 activate Switch
diff --git a/assets/diagrams/sequence/figure54.plantuml b/assets/diagrams/sequence/figure54.plantuml
@@ -143,4 +143,6 @@ PayerFSP -> PayerFSP: Cancel transfer from Payer\naccount to Switch
 Payer <- PayerFSP: Transaction failure notification
 deactivate PayerFSP
 PayeeFSP -> PayeeFSP: Cancel reservation
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
 @enduml
diff --git a/assets/diagrams/sequence/figure58.plantuml b/assets/diagrams/sequence/figure58.plantuml
@@ -143,4 +143,6 @@ Loop #OldLace
   PayerFSP -> PayerFSP: Rate payer FSP bulk quote\n(depending on fee model)
 end Loop
 PayerFSP -> PayerFSP: Handle quote results for\nall Payee FSPs
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
 @enduml
diff --git a/assets/diagrams/sequence/figure63.plantuml b/assets/diagrams/sequence/figure63.plantuml
@@ -157,8 +157,9 @@ PayerFSP -->> Switch: **HTTP 200** (OK)
 deactivate Switch
 deactivate PayerFSP
 autonumber resume
-PayerFSP -> PayerFSP: Rate Payer FSP quote\n(depending on fee model)
+PayerFSP -[hidden]> Switch
 activate PayerFSP
+PayerFSP -> PayerFSP: Rate Payer FSP quote\n(depending on fee model)
 PayerFSP ->> Switch: **POST /quotes**\n(Transaction details)
 activate Switch
 autonumber stop
@@ -230,23 +231,23 @@ group #OldLace Optional
   hnote left of PayerFSP #OldLace
     Get transaction data
   end hnote
-  PayerFSP ->> Switch: **GET /transactions/** <i><TransactionID></i>
+  PayerFSP ->> Switch: **GET /transactions/**<i><TransactionID></i>
   activate Switch
   autonumber stop
   PayerFSP <<-- Switch: **HTTP 202** (Accepted)
   autonumber resume
-  Switch <<- PayeeFSP: **GET /transactions/** <i><TransactionID></i>
+  Switch <<- PayeeFSP: **GET /transactions/**<i><TransactionID></i>
   activate PayeeFSP
   autonumber stop
   Switch -->> PayeeFSP: **HTTP 202** (Accepted)
   autonumber resume
   PayeeFSP -> PayeeFSP: Lookup\ntransaction\ninformation
-  Switch <<- PayeeFSP: **PUT /transactions/** <i><TransactionID></i>\n(Transaction details)
+  Switch <<- PayeeFSP: **PUT /transactions/**<i><TransactionID></i>\n(Transaction details)
   autonumber stop
   Switch -->> PayeeFSP: **HTTP 200** (OK)
   deactivate PayeeFSP
   autonumber resume
-  PayerFSP <<- Switch: **PUT /transactions/** <i><TransactionID></i>\n(Transaction details)
+  PayerFSP <<- Switch: **PUT /transactions/**<i><TransactionID></i>\n(Transaction details)
   autonumber stop
   PayerFSP -->> Switch: **HTTP 200** (OK)
   deactivate Switch
diff --git a/assets/diagrams/sequence/figure63a.plantuml b/assets/diagrams/sequence/figure63a.plantuml
@@ -143,8 +143,9 @@ autonumber resume
 PayerFSP <<- Switch: **Return Party Information**\n(Party Information)
 deactivate Switch
 deactivate PayerFSP
-PayerFSP -> PayerFSP: Rate Payer FSP quote\n(depending on fee model)
+PayerFSP -[hidden]> Switch
 activate PayerFSP
+PayerFSP -> PayerFSP: Rate Payer FSP quote\n(depending on fee model)
 PayerFSP ->> Switch: **Calculate Quote**\n(Transaction details)
 activate Switch
 Switch ->> PayeeFSP: **Calculate Quote**\n(Transaction details)
diff --git a/assets/diagrams/sequence/figure64a.plantuml b/assets/diagrams/sequence/figure64a.plantuml
@@ -134,8 +134,8 @@ Switch <<- PayeeFSP: **Perform Transaction Request**\n(Payee information, transa
 activate PayeeFSP
 activate Switch
 PayerFSP <<- Switch: **Perform Transaction Request**\n(Payee information,\ntransaction details)
-activate PayerFSP
 deactivate Switch
+activate PayerFSP
 PayerFSP -> PayerFSP: Perform optional validation
 PayerFSP ->> Switch: **Return Transaction**\n**Request Information**\n(Received status)
 activate Switch
@@ -176,11 +176,11 @@ Alt #OldLace Alternatives
   Payer -> PayerFSP: I reject the\ntransaction request
   activate PayerFSP
   PayerFSP ->> Switch: **Return Transaction**\n**Request Information**\n(Rejected state)
-  activate Switch
   deactivate PayerFSP
+  activate Switch
   Switch ->> PayeeFSP: **Return Transaction Request Information**\n(Rejected state)
-  activate PayeeFSP
   deactivate Switch
+  activate PayeeFSP
   PayeeFSP -> Payee: Transaction failed\ndue to user\nrejection
   deactivate PayeeFSP
   autonumber stop
diff --git a/assets/diagrams/sequence/figure65.plantuml b/assets/diagrams/sequence/figure65.plantuml
@@ -170,9 +170,12 @@ autonumber stop
 Switch <<-- PayeeFSP: **HTTP 200** (OK)
 deactivate Switch
 deactivate PayeeFSP
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
+PayerFSP -[hidden]> Switch
+activate PayerFSP
 autonumber resume
 PayerFSP -> PayerFSP: Rate Payer FSP quote\n(depending on fee model)
-activate PayerFSP
 PayerFSP ->> Switch: **POST /qoutes**\n(Transaction details)
 activate Switch
 autonumber stop
@@ -205,16 +208,19 @@ PayerFSP -->> Switch: **HTTP 200** (OK)
 deactivate Switch
 autonumber resume
 PayerFSP -> PayerFSP: Rate Payer FSP quote\n(depending on fee model)
+autonumber stop
+PayerFSP -[hidden]> Switch
 deactivate PayerFSP
 Group #Oldlace Option #2
   hnote left of Payer #Oldlace
     Automatic
     generated
     OTP
   end hnote
+  PayerFSP -[hidden]> Switch
+  activate PayerFSP
   autonumber resume
   PayerFSP -> PayerFSP: Generate OTP
-  activate PayerFSP
   Payer <- PayerFSP: Use OTP\nto confirm
 end
 PayerFSP ->> Switch: **GET /authorizations/**\n<i><TransactionRequestID></i>\n(Amount and fees)
@@ -243,19 +249,22 @@ PayerFSP -->> Switch: **HTTP 200** (OK)
 deactivate Switch
 autonumber resume
 PayerFSP -> PayerFSP: Validate OTP sent by Payee FSP
-...
-'deactivate PayerFSP
+autonumber stop
+PayerFSP -[hidden]> Switch
+deactivate PayerFSP
 Group #Oldlace Alternatives
   hnote left of Payer #Oldlace
     OTP
     validation
     failed
   end hnote
+  autonumber resume
   PayerFSP ->> Switch: **PUT /transactionRequests/**<i><ID></i>\n(Rejected state)
-'  activate PayerFSP
+  activate PayerFSP
   activate Switch
   autonumber stop
   PayerFSP <<-- Switch: **HTTP 200** (OK)
+  deactivate PayerFSP
   autonumber resume
   Switch ->> PayeeFSP: **PUT /transactionRequests/**<i><ID></i>\n(Rejected state)
   activate PayeeFSP
@@ -266,14 +275,15 @@ Group #Oldlace Alternatives
   PayeeFSP -> Payee: Transaction\nfailed due to\nincorrect OTP
   deactivate PayeeFSP
   autonumber stop
-  ...
 else
   hnote left of Payer #Oldlace
       OTP
       validation
       successful
   end hnote
+  PayerFSP -[hidden]> Switch
   autonumber 33 1
+  activate PayerFSP
   PayerFSP -> PayerFSP: Reserve transfer from Payer\naccount to Switch account
   autonumber stop
   PayerFSP ->> Switch: **POST /transfers**\n(Transfer ID, condition,\nILP packet including transaction ID)
@@ -300,12 +310,14 @@ else
   deactivate Switch
   autonumber resume
   PayerFSP -> PayerFSP: Commits transfer from Payer\naccount to Payee FSP account
-  ...
+  autonumber stop
+  PayerFSP -[hidden]> Switch
   Group #Lightgrey Optional
     hnote left of PayerFSP #Lightgrey
       Get transaction
       data
     end hnote
+    autonumber resume
     PayerFSP ->> Switch: **GET /transactions/**<i><TransactionID></i>
     activate Switch
     autonumber stop
diff --git a/assets/diagrams/sequence/figure65a.plantuml b/assets/diagrams/sequence/figure65a.plantuml
diff --git a/assets/diagrams/sequence/figure66.plantuml b/assets/diagrams/sequence/figure66.plantuml
diff --git a/assets/diagrams/sequence/figure66a.plantuml b/assets/diagrams/sequence/figure66a.plantuml
diff --git a/assets/diagrams/sequence/figure68.plantuml b/assets/diagrams/sequence/figure68.plantuml
diff --git a/assets/diagrams/sequence/figure69.plantuml b/assets/diagrams/sequence/figure69.plantuml
diff --git a/documents/API Definition v1.0.md b/documents/API Definition v1.0.md
