Feature/markdown documents (#44)

* - 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 too 8.8.1. Co-authored-by: Sam <[email protected]>
mojaloop · Jan 22, 2020 · 3827ea5 · 3827ea5
1 parent d64b399
commit 3827ea5
Show file tree

Hide file tree

Showing 13 changed files with 4,101 additions and 23 deletions.
diff --git a/SUMMARY.md b/SUMMARY.md
@@ -3,7 +3,9 @@
 ### Documents
 * [Mojaloop Specifications Overview](README.md)
   * [Glossary](documents/Glossary.md)
+  * [Generic Transaction Patterns](documents/Generic Transaction Patterns.md)
   * [API Definition v1.0](documents/API Definition v1.0.md)
+  * [JSON Binding Rules](documents/JSON Binding Rules.md)
   * [Encryption](documents/Encryption.md)
 ### Change Control Board
 * [Change Control Board Overview](ccb-meetings/README.md)

diff --git a/assets/diagrams/sequence/figure63.plantuml b/assets/diagrams/sequence/figure63.plantuml
@@ -129,7 +129,7 @@ activate Switch
 autonumber stop
 PayerFSP <<-- Switch: **HTTP 202** (Accepted)
 autonumber resume
-Switch ->> ALS: **GET /parties/MSISDN/123456789**
+Switch ->> ALS: **GET /participants/MSISDN/123456789**
 activate ALS
 autonumber stop
 Switch <<-- ALS: **HTTP 202** (Accepted)

diff --git a/assets/diagrams/sequence/figure63a.plantuml b/assets/diagrams/sequence/figure63a.plantuml
@@ -0,0 +1,212 @@
+/'*****
+License
+--------------
+Copyright © 2017 Bill & Melinda Gates Foundation
+The Mojaloop files are made available by the Bill & Melinda Gates Foundation under the Apache License, Version 2.0 (the "License") and you may not use these files except in compliance with the License. You may obtain a copy of the License at
+http://www.apache.org/licenses/LICENSE-2.0
+Unless required by applicable law or agreed to in writing, the Mojaloop files are distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
+Contributors
+--------------
+This is the official list of the Mojaloop project contributors for this file.
+Names of the original copyright holders (individuals or organizations)
+should be listed with a '*' in the first column. People who have
+contributed from an organization can be listed under the organization
+that actually holds the copyright for their contributions (see the
+Gates Foundation organization for an example). Those individuals should have
+their names indented and be marked with a '-'. Email address can be added
+optionally within square brackets <email>.
+* Gates Foundation
+- Name Surname <[email protected]>
+
+* Henk Kodde <[email protected]>
+--------------
+******'/
+
+@startuml
+
+' define actor image
+sprite $actor [25x48/16] {
+  0000000000010000000000000
+  0000000006CAC910000000000
+  0000000095101292000000000
+  0000000651000119000000000
+  0000000B10000018400000000
+  0000001A10000016600000000
+  0000000B10000017510000000
+  000000083100001A210000000
+  0000000191000176110000000
+  000000003A866A61100000000
+  0000000000466211100000000
+  0003333333334443333310000
+  0088888888888888888892000
+  0821111111111111111118200
+  8311111111111111111111A00
+  A111111111111111111111A20
+  A111111111111111111111A20
+  A111111111111111111111A20
+  A111111111111111111111A20
+  A111111111111111111111A20
+  A111111111111111111111A20
+  A111111111111111111111A20
+  A111111111111111111111A20
+  A111551111111111138111A20
+  A111661111111111139111A20
+  A211661111111111139111A20
+  A211661111111111139111A20
+  A211661111161111139111A20
+  A2116611111A2111139111A20
+  A2116611111A2111139111A20
+  A2116611111A2111139111A20
+  A7669611111A211113A666B20
+  36669611111A211113A666610
+  00016611111A2111139111110
+  00006611111A2111139100000
+  00006611111A2111139100000
+  00006611111A2111139100000
+  00006611111A2111139100000
+  00006611111A2111139100000
+  00006611111A2111139100000
+  00006611111A2111139100000
+  00006611111A2111139100000
+  00006611111A2111139100000
+  00006611111A2111139100000
+  00006966666B7666679100000
+  0000266666666666664100000
+  0000000111111111111100000
+  0000000000000000000000000
+}
+
+' declaring skinparam
+skinparam sequenceMessageAlign center
+skinparam shadowing false
+skinparam defaultFontName Verdana
+skinparam monochrome true
+skinparam SequenceLifeLineBackgroundColor WhiteSmoke
+skinparam SequenceLifeLineBorderColor Black
+skinparam ActorFontStyle Bold
+skinparam ActorFontSize 20
+skinparam ParticipantFontStyle Bold
+skinparam ParticipantFontSize 20
+skinparam ParticipantBackgroundColor WhiteSmoke
+skinparam ArrowColor Black
+
+skinparam actor {
+  Bordercolor none
+  Backgroundcolor none
+  shadowing false
+}
+
+skinparam participant {
+  shadowing true
+}
+
+hide footbox
+
+' declare title
+' title Payer-Initiated Transaction
+
+' Actor Keys:
+' participant - FSP(Payer/Payee), Switch and Account Lookup
+' actor - Payer/Payee(s)
+
+' declare actors
+actor "<$actor>\nPayer" as Payer
+participant "Payer\nFSP" as PayerFSP
+participant "Optional\nSwitch" as Switch
+participant "Account\nLookup" as ALS
+participant "Payee\nFSP" as PayeeFSP
+actor "<$actor>\nPayee" as Payee
+
+' start flow
+autonumber 1 1 "<b>[0]"
+Payer -> PayerFSP: I would like to\npay 100 USD\nto +123456789
+activate PayerFSP
+PayerFSP -> PayerFSP: Payee not within\nPayer FSP system
+autonumber stop
+PayerFSP ->> Switch: **Lookup Party Information**\n(MSISDN 123456789)
+activate Switch
+autonumber resume
+Switch ->> ALS: **Lookup Participant Information**\n(MSISDN 123456789)
+activate ALS
+ALS -> ALS: Lookup which\nFSP MSISDN\n+123456789\nbelongs to
+autonumber stop
+Switch <<- ALS: **Return Participant Information**\n(FSP ID)
+deactivate ALS
+autonumber resume
+Switch ->> PayeeFSP: **Lookup Party Information**\n(MSISDN 123456789)
+activate PayeeFSP
+PayeeFSP -> PayeeFSP: Lookup party\ninformation\nregarding\nMSISDN\n+123456789
+autonumber stop
+Switch <<- PayeeFSP: **Return Party Information**\n(Party Information)
+deactivate PayeeFSP
+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)
+activate PayerFSP
+PayerFSP ->> Switch: **Calculate Quote**\n(Transaction details)
+activate Switch
+Switch ->> PayeeFSP: **Calculate Quote**\n(Transaction details)
+activate PayeeFSP
+PayeeFSP -> PayeeFSP: Rate Payee FSP\nfee/commission,\ngenerate condition
+group #OldLace Optional
+  hnote left of PayeeFSP #OldLace
+    Confirm quote
+  end hnote
+  PayeeFSP -> Payee: Here is the\nquote and\nPayer name
+  autonumber stop
+  PayeeFSP <- Payee: I confirm
+end
+autonumber resume
+Switch <<- PayeeFSP: **Return Quote Information**\n(Payee FSP fee/commission,\ncondition)
+deactivate PayeeFSP
+PayerFSP <<- Switch: **Return Quote Information**\n(Payee FSP fee/commission,\ncondition)
+deactivate Switch
+PayerFSP -> PayerFSP: Rate Payer FSP quote\n(depending on fee model)
+autonumber stop
+Payer <- PayerFSP: Present fees and\noptionally payee name
+deactivate PayerFSP
+autonumber resume
+Payer -> PayerFSP: I approve the\ntransaction
+activate PayerFSP
+autonumber stop
+PayerFSP -> PayerFSP: Reserve transfer from Payer\naccount to Switch account
+autonumber resume
+PayerFSP -> Switch: **Preform Transfers**\n(Transfer ID, condition, ILP packet\nincluding transaction ID)
+activate Switch
+Switch -> Switch: Reserve transfer from\nPayer FSP to Payee FSP
+autonumber stop
+Switch ->> PayeeFSP: **Perform Transfer**\n(Transfer ID, condition, ILP packet\nincluding transaction ID)
+activate PayeeFSP
+autonumber resume
+PayeeFSP -> PayeeFSP: Perform transfer\nfrom Switch\naccount to Payee\naccount, generate\nfulfilment
+PayeeFSP -> Payee: Transaction notification
+autonumber stop
+Switch <<- PayeeFSP: **Return Transfer Information**\n(Fulfilment)
+deactivate PayeeFSP
+autonumber resume
+Switch -> Switch: Commit transfer from\nPayer FSP to Payee FSP
+autonumber stop
+PayerFSP <<- Switch: **Return Transfer Information**\n(Fulfilment)
+deactivate Switch
+autonumber resume
+PayerFSP -> PayerFSP: Commit transfer from Payer\naccount to Switch account
+group #OldLace Optional
+  hnote left of PayerFSP #OldLace
+    Get transaction data
+  end hnote
+  PayerFSP ->> Switch: **Retrieve Transaction Information**\n(Transaction ID)
+  activate Switch
+  Switch <<- PayeeFSP: **Retrieve Transaction Information**\n(Transaction ID)
+  activate PayeeFSP
+  PayeeFSP -> PayeeFSP: Lookup\ntransaction\ninformation
+  Switch <<- PayeeFSP: **Return Transaction Information**\n(Transaction details)
+  deactivate PayeeFSP
+  PayerFSP <<- Switch: **Return Transaction Information**\n(Transaction details)
+  deactivate Switch
+end
+Payer <- PayerFSP: Transaction notification\nincluding optional\ntransaction data\n(e.g. token ID)
+deactivate PayerFSP
+autonumber stop
+@enduml
diff --git a/assets/diagrams/sequence/figure64.plantuml b/assets/diagrams/sequence/figure64.plantuml
@@ -127,7 +127,7 @@ ALS <<- PayeeFSP: **GET /participants/MSISDN/123456789**
 activate ALS
 ALS -->> PayeeFSP: **HTTP 202** (Accepted)
 autonumber resume
-ALS -> ALS: Lookup which FSP MSISDN\n+123456789 belongins to
+ALS -> ALS: Lookup which FSP MSISDN\n+123456789 belongs to
 ALS ->> PayeeFSP: **PUT /participants/MSISDN/123456789**\n(FSP ID)
 autonumber stop
 ALS <<-- PayeeFSP: **HTTP 200** (OK)