Skip to content

Commit 650aa7b

Browse files
HenkKoddeSam
andauthored
Create Signature.md. (#50)
* - 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. * 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 whitespace 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 ** * Tiding up of sequence diagrams. * Create "figure1_http_timeout" and "figure2_callback_timeout" sequence diagrams. Create "Scheme Rules" in markdown. Updated SUMMARY.md with new document for rendering in GitBooks. Updated README.md file to reference to markdown documents. Removed duplicated section in README.md Updated version to 9.1.1. * Added link to internal document reference. * Updated Contributors. * Created "Signature.md" document. Updated "SUMMARY.md" to include "Signature.md" document. Updated "Generic Transaction Patterns.md" and "JSON Binding Rules.md" to have the same look and feel as the other documents. Corrected invalid index reference on "Scheme Rules.md". Updated "README.md" to refer to "Signature.md". Version 9.2.0. * Changed the document version dates to "2018-03-13" as suggested. Created "Use Cases.md" in markdown format Update reference in "README.md" to point to "Use Cases.md" Included "Use Cases.md" in SUMMARY.md. Co-authored-by: Sam <[email protected]>
1 parent 89f9a47 commit 650aa7b

File tree

12 files changed

+1581
-71
lines changed

12 files changed

+1581
-71
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Information is shared in accordance with **Creative Commons Licensing**.
3434
[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/Generic%20Transaction%20Patterns.md) specifies the logical data model used by the API. Section 2 in the document lists elements used by each service. Section 3 in the document describes the data model in terms of basic elements, simple data types and complex data types.
3535

3636
## Use Cases
37-
The purpose of [this document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/supporting-documentation/Use%20Cases.pdf) is to define a set of use cases that can be implemented using the API. The use cases referenced within this document provide an overview of transaction processing flows and business rules of each transaction step as well as relevant error conditions. The primary purpose of the API is to support the movement of financial transactions between one Financial Services Provider (FSP) and another.
37+
The purpose of [this document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/Use%20Cases.md) is to define a set of use cases that can be implemented using the API. The use cases referenced within this document provide an overview of transaction processing flows and business rules of each transaction step as well as relevant error conditions. The primary purpose of the API is to support the movement of financial transactions between one Financial Services Provider (FSP) and another.
3838

3939
It should be noted that the API is only responsible for message exchange between FSPs and a Switch when a cross-FSP transaction is initiated by an End User in one of the FSPs. This can occur in either of two scenarios:
4040
- A bilateral scenario in which FSPs communicate with each other
@@ -84,7 +84,7 @@ The API should be implemented in an environment that consists of either:
8484
For more information about the environment, see Chapter 3, Network Topology. Chapters 4 and 5 identify management strategies for the CA and for the platform. Communication between platforms is performed using a REST (REpresentational State Transfer)-based HTTP protocol (for more information, see API Definition). Because this protocol does not provide a means for ensuring either integrity or confidentiality between platforms, extra security layers must be added to protect sensitive information from alteration or exposure to unauthorized parties.
8585

8686
## Signature
87-
[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/supporting-documentation/Signature.pdf) details security methods to be implemented for **the API** to ensure confidentiality of API messages between an API client and the API server.
87+
[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/Signature.md) details security methods to be implemented for **the API** to ensure confidentiality of API messages between an API client and the API server.
8888

8989
In information security, confidentiality means that information is not made available or disclosed to unauthorized individuals, entities, or processes (Excerpt [ISO27000](http://www.27000.org/ ) ). For the API, confidentiality means that some sensitive fields in the payload of an API message cannot be accessed or identified in an unauthorized or undetected manner by the intermediaries involved in the API communication. That is, if some fields of an API message are encrypted by the API client, then only the expected API recipient can decrypt those fields.
9090

SUMMARY.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,13 @@
44
* [Mojaloop Specifications Overview](README.md)
55
* [Glossary](documents/Glossary.md)
66
* [Generic Transaction Patterns](documents/Generic Transaction Patterns.md)
7+
* [Use Cases](documents/Use Cases.md)
78
* [API Definition v1.0](documents/API Definition v1.0.md)
89
* [Scheme Rules](documents/Scheme Rules.md)
910
* [JSON Binding Rules](documents/JSON Binding Rules.md)
11+
* [Scheme Rules](documents/Scheme Rules.md)
1012
* [PKI Best Practices](documents/PKI Best Practices.md)
13+
* [Signature](documents/Signature.md)
1114
* [Encryption](documents/Encryption.md)
1215
### Change Control Board
1316
* [Change Control Board Overview](ccb-meetings/README.md)

documents/Encryption.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ The following conventions are used in this document to identify the specified ty
5353

5454
| **Version** | **Date** | **Change Description** |
5555
| :--- | :--- | :--- |
56-
| **1.0** | 2019-02-22 | Initial version |
56+
| **1.0** | 2018-03-13 | Initial version |
5757

5858
# 2. Introduction
5959

documents/Generic Transaction Patterns.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,52 @@
11
# Generic Transaction Patterns
22

3-
## Open API for FSP Interoperability Specification
3+
## _Open API for FSP Interoperability Specification_
44

55
**Table of Contents**
66

7-
[1. Preface](#1-preface)
7+
1. [Preface](#1-preface)
88

9-
[1.1 Conventions Used in This Document](#11-conventions-used-in-this-document)
9+
1.1 [Conventions Used in This Document](#11-conventions-used-in-this-document)
1010

11-
[1.2 Document Version Information](#12-document-version-information)
11+
1.2 [Document Version Information](#12-document-version-information)
1212

13-
[2. Introduction](#2-introduction)
13+
2. [Introduction](#2-introduction)
1414

15-
[2.1 Open API for FSP Interoperability Specification](#21-open-api-for-fsp-interoperability-specification)
15+
2.1 [Open API for FSP Interoperability Specification](#21-open-api-for-fsp-interoperability-specification)
1616

17-
[3. Logical API Services](#3-logical-api-services)
17+
3. [Logical API Services](#3-logical-api-services)
1818

19-
[3.1 Common Functionality](#31-common-functionality)
19+
3.1 [Common Functionality](#31-common-functionality)
2020

21-
[3.2 API Resource Participants](#32-api-resource-participants)
21+
3.2 [API Resource Participants](#32-api-resource-participants)
2222

23-
[3.3 API Resource Parties](#33-api-resource-parties)
23+
3.3 [API Resource Parties](#33-api-resource-parties)
2424

25-
[3.4 API Resource Transaction Requests](#34-api-resource-transaction-requests)
25+
3.4 [API Resource Transaction Requests](#34-api-resource-transaction-requests)
2626

27-
[3.5 API Resource Quotes](#35-api-resource-quotes)
27+
3.5 [API Resource Quotes](#35-api-resource-quotes)
2828

29-
[3.6 API Resource Authorizations](#36-api-resource-authorizations)
29+
3.6 [API Resource Authorizations](#36-api-resource-authorizations)
3030

31-
[3.7 API Resource Transfers](#37-api-resource-transfers)
31+
3.7 [API Resource Transfers](#37-api-resource-transfers)
3232

33-
[3.8 API Resource Transactions](#38-api-resource-transactions)
33+
3.8 [API Resource Transactions](#38-api-resource-transactions)
3434

35-
[3.9 API Resource Bulk Quotes](#39-api-resource-bulk-quotes)
35+
3.9 [API Resource Bulk Quotes](#39-api-resource-bulk-quotes)
3636

37-
[3.10 API Resource Bulk Transfers](#310-api-resource-bulk-transfers)
37+
3.10 [API Resource Bulk Transfers](#310-api-resource-bulk-transfers)
3838

39-
[4. Generic Transaction Patterns](#4-generic-transaction-patterns)
39+
4. [Generic Transaction Patterns](#4-generic-transaction-patterns)
4040

41-
[4.1 Payer-Initiated Transaction](#41-payer-initiated-transaction)
41+
4.1 [Payer-Initiated Transaction](#41-payer-initiated-transaction)
4242

43-
[4.2 Payee-Initiated Transaction](#42-payee-initiated-transaction)
43+
4.2 [Payee-Initiated Transaction](#42-payee-initiated-transaction)
4444

45-
[4.3 Payee-Initiated Transaction using OTP](#43-payee-initiated-transaction-using-otp)
45+
4.3 [Payee-Initiated Transaction using OTP](#43-payee-initiated-transaction-using-otp)
4646

47-
[4.4 Bulk Transactions](#44-bulk-transactions)
47+
4.4 [Bulk Transactions](#44-bulk-transactions)
4848

49-
[5. References](#5-references)
49+
5. [References](#5-references)
5050

5151
**Table of Figures**
5252

@@ -77,7 +77,7 @@ The following conventions are used in this document to identify the specified ty
7777

7878
|Version|Date|Change Description|
7979
|---|---|---|
80-
|**1.0**|2019-03-12|Initial version|
80+
|**1.0**|2018-03-13|Initial version|
8181

8282
## 2. Introduction
8383

documents/Glossary.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ The following conventions are used in this document to identify the specified ty
3535

3636
| **Version** | **Date** | **Change Description** |
3737
| :--- | :--- | :--- |
38-
| **1.0** | 2019-03-05 | Initial version |
38+
| **1.0** | 2018-03-13 | Initial version |
3939

4040
# 2. Introduction
4141

documents/JSON Binding Rules.md

Lines changed: 35 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,78 +1,77 @@
11
---
22
showToc: true
33
---
4-
54
# JSON Binding Rules
65

7-
## Open API for FSP Interoperability Specification
6+
## _Open API for FSP Interoperability Specification_
87

98
**Table of Contents**
109

11-
[1. Preface](#1-preface)
10+
1. [Preface](#1-preface)
1211

13-
[1.1 Conventions Used in This Document](#11-conventions-used-in-this-document)
12+
1.1 [Conventions Used in This Document](#11-conventions-used-in-this-document)
1413

15-
[1.2 Document Version Information](#12-document-version-information)
14+
1.2 [Document Version Information](#12-document-version-information)
1615

17-
[2. Introduction](#2-introduction)
16+
2. [Introduction](#2-introduction)
1817

19-
[2.1 Open API for FSP Interoperability Specification](#21-open-api-for-fsp-interoperability-specification)
18+
2.1 [Open API for FSP Interoperability Specification](#21-open-api-for-fsp-interoperability-specification)
2019

21-
[3. Keywords and Usage](#3-keywords-and-usage)
20+
3. [Keywords and Usage](#3-keywords-and-usage)
2221

23-
[3.1 Validation Keywords](#31-validation-keywords)
22+
3.1 [Validation Keywords](#31-validation-keywords)
2423

25-
[3.2 Metadata Keywords](#32-metadata-keywords)
24+
3.2 [Metadata Keywords](#32-metadata-keywords)
2625

27-
[3.3 Instance and \$ref](#33-instance-and-$ref)
26+
3.3 [Instance and \$ref](#33-instance-and-$ref)
2827

29-
[3.4 JSON Definitions and Examples](#34-json-definitions-and-examples)
28+
3.4 [JSON Definitions and Examples](#34-json-definitions-and-examples)
3029

31-
[4. Element and Basic Data Types](#4-element-and-basic-data-types)
30+
4. [Element and Basic Data Types](#4-element-and-basic-data-types)
3231

33-
[4.1 Data Type Amount](#41-data-type-amount)
32+
4.1 [Data Type Amount](#41-data-type-amount)
3433

35-
[4.2 Data Type BinaryString](#42-data-type-binaryString)
34+
4.2 [Data Type BinaryString](#42-data-type-binaryString)
3635

37-
[4.3 Data Type BinaryString32](#43-data-type-binaryString32)
36+
4.3 [Data Type BinaryString32](#43-data-type-binaryString32)
3837

39-
[4.4 Data Type BopCode](#44-data-type-bopcode)
38+
4.4 [Data Type BopCode](#44-data-type-bopcode)
4039

41-
[4.5 Data Type Enum](#45-data-type-enum)
40+
4.5 [Data Type Enum](#45-data-type-enum)
4241

43-
[4.6 Data Type Date](#46-data-type-date)
42+
4.6 [Data Type Date](#46-data-type-date)
4443

45-
[4.7 Data Type DateTime](#47-data-type-datetime)
44+
4.7 [Data Type DateTime](#47-data-type-datetime)
4645

47-
[4.8 Data Type ErrorCode](#48-data-type-errorcode)
46+
4.8 [Data Type ErrorCode](#48-data-type-errorcode)
4847

49-
[4.9 Data Type Integer](#49-data-type-integer)
48+
4.9 [Data Type Integer](#49-data-type-integer)
5049

51-
[4.10 Data Type Latitude](#410-data-type-latitude)
50+
4.10 [Data Type Latitude](#410-data-type-latitude)
5251

53-
[4.11 Data Type Longitude](#411-data-type-longitude)
52+
4.11 [Data Type Longitude](#411-data-type-longitude)
5453

55-
[4.12 Data Type MerchantClassificationCode](#412-data-type-merchantclassificationcode)
54+
4.12 [Data Type MerchantClassificationCode](#412-data-type-merchantclassificationcode)
5655

57-
[4.13 Data Type Name](#413-data-type-name)
56+
4.13 [Data Type Name](#413-data-type-name)
5857

59-
[4.14 Data Type OtpValue](#414-data-type-otpvalue)
58+
4.14 [Data Type OtpValue](#414-data-type-otpvalue)
6059

61-
[4.15 Data Type String](#415-data-type-string)
60+
4.15 [Data Type String](#415-data-type-string)
6261

63-
[4.16 Data Type TokenCode](#416-data-type-tokencode)
62+
4.16 [Data Type TokenCode](#416-data-type-tokencode)
6463

65-
[4.17 Data Type UndefinedEnum](#417-data-type-undefinedenum)
64+
4.17 [Data Type UndefinedEnum](#417-data-type-undefinedenum)
6665

67-
[4.18 Data Type UUID](#418-data-type-uuid)
66+
4.18 [Data Type UUID](#418-data-type-uuid)
6867

69-
[5. Complex Type](#5-complex-type)
68+
5. [Complex Type](#5-complex-type)
7069

71-
[5.1 Complex Type Definition, Transformation](#51-complex-type-definition,-transformation)
70+
5.1 [Complex Type Definition, Transformation](#51-complex-type-definition,-transformation)
7271

73-
[5.2 Types of objects in Requests or Responses](#52-types-of-objects-in-requests-or-responses)
72+
5.2 [Types of objects in Requests or Responses](#52-types-of-objects-in-requests-or-responses)
7473

75-
[6. References](#6-references)
74+
6. [References](#6-references)
7675

7776
**Table of Listings**
7877

@@ -157,7 +156,7 @@ The following conventions are used in this document to identify the specified ty
157156

158157
|Version|Date|Change Description|
159158
|---|---|---|
160-
|**1.0**|2019-03-12|Initial version|
159+
|**1.0**|2018-03-13|Initial version|
161160

162161
## 2. Introduction
163162

documents/PKI Best Practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -116,7 +116,7 @@ The following conventions are used in this document to identify the specified ty
116116

117117
|Version|Date|Change Description|
118118
|---|---|---|
119-
|**1.0**|2019-03-12|Initial version|
119+
|**1.0**|2018-03-13|Initial version|
120120

121121
## 2. Introduction
122122

documents/Scheme Rules.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
---
22
showToc: true
33
---
4+
# Scheme Rules
45

5-
#Scheme Rules
6-
##Open API for FSP Interoperability Specification
6+
## _Open API for FSP Interoperability Specification_
77

88
**Table of Contents**
99

1010
1. [Preface](#1-preface)
1111

1212
1.1 [Conventions Used in This Document](#11-conventions-used-in-this-document)
1313

14-
1.2 Document Version Information](#12-document-version-information)
14+
1.2 [Document Version Information](#12-document-version-information)
1515

1616
2. [Introduction](#2-introduction)
1717

@@ -104,7 +104,7 @@ The following conventions are used in this document to identify the specified ty
104104

105105
|Version|Date|Change Description|
106106
|---|---|---|
107-
|**1.0**|2019-03-12|Initial version|
107+
|**1.0**|2018-03-13|Initial version|
108108

109109
##2. Introduction
110110

0 commit comments

Comments
 (0)