Feature/markdown documents (#49)

* - 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.

Co-authored-by: Sam <[email protected]>

Author: HenkKodde

README.md

@@ -31,7 +31,7 @@ Information is shared in accordance with **Creative Commons Licensing**.
 [This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/supporting-documentation/Logical%20Data%20Model.pdf) introduces the four generic transaction patterns that are supported in a logical version of the API. Additionally, all logical services that are part of the API are presented on a high-level.
 
 ## Generic Transaction Patterns
-[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/supporting-documentation/Generic%20Transaction%20Patterns.pdf) 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.
+[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.
 
 ## Use Cases
 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.
@@ -54,7 +54,7 @@ This document:
 - Adds to and builds on the information provided in Open API for FSP Interoperability Specification. The contents of the Specification are listed in Section **Open API for FSP Interoperability Specification**.
 
 ## Scheme Rules
-[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/supporting-documentation/Scheme%20Rules.pdf) defines scheme rules for Open API for FSP Interoperability (hereafter cited as the API) in three categories.
+[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/Scheme%20Rules.md) defines scheme rules for Open API for FSP Interoperability (hereafter cited as the API) in three categories.
 1.	Business Scheme Rules:   
 a.	These business rules should be governed by FSPs and an optional regulatory authority implementing the API within a scheme.   
 b.	The regulatory authority or implementing authority should identify valid values for these business scheme rules in their API policy document.   
@@ -65,7 +65,7 @@ b.	All participants should configure these API parameters as indicated by the AP
 a.	Security and non-functional scheme rules should be determined and identified in the implementation policy of a scheme.   
 
 ## JSON Binding Rules
-The purpose of [this document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/supporting-documentation/JSON%20Binding%20Rules.pdf) is to express the data model used by **the API** in the form of JSON Schema binding rules, along with validation rules for the corresponding instances.
+The purpose of [this document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/JSON%20Binding%20Rules.md) is to express the data model used by **the API** in the form of JSON Schema binding rules, along with validation rules for the corresponding instances.
 
 This document adds to and builds on the information provided in Open API for FSP Interoperability Specification. The contents of the Specification are listed in Section 1.1.
 The types used in the PDP API fall primarily into three categories:
@@ -75,19 +75,8 @@ The types used in the PDP API fall primarily into three categories:
 
 The various types used in API Definition, Data Model and the Open API Specification, as well as the JSON transformation rules to which their instances must adhere, are identified in the following sections.
 
-## Scheme Rules
-[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/supporting-documentation/Scheme%20Rules.pdf) defines scheme rules for Open API for FSP Interoperability (hereafter cited as the API) in three categories.
-1.	**Business** Scheme Rules:   
-a.	These business rules should be governed by FSPs and an optional regulatory authority implementing the API within a scheme.   
-b.	The regulatory authority or implementing authority should identify valid values for these business scheme rules in their API policy document.   
-2.	**API implementation** Scheme Rules:   
-a.	These API parameters should be agreed on by FSPs and the optional Switch. These parameters should be part of the implementation policy of a scheme.   
-b.	All participants should configure these API parameters as indicated by the API-level scheme rules for the implementation with which they are working.   
-3.	**Security** and **Non-Functional** Scheme Rules.   
-a.	Security and non-functional scheme rules should be determined and identified in the implementation policy of a scheme.   
-
 ## PKI Best Practices
-[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/supporting-documentation/PKI%20Best%20Practices.pdf) explains Public Key Infrastructure (PKI)  best practices to apply in **the API** deployment. See Chapter 2, PKI Background, for more information about PKI. 
+[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/PKI%20Best%20Practices.md) explains Public Key Infrastructure (PKI)  best practices to apply in **the API** deployment. See Chapter 2, PKI Background, for more information about PKI. 
 The API should be implemented in an environment that consists of either:
 - Financial Service Providers (FSPs) that communicate with other FSPs (in a bilateral setup) or 
 - A Switch that acts as an intermediary platform between FSP platforms. There is also an Account Lookup System (ALS) available to identify in which FSP an account holder is located.

SUMMARY.md

@@ -5,9 +5,10 @@
   * [Glossary](documents/Glossary.md)
   * [Generic Transaction Patterns](documents/Generic Transaction Patterns.md)
   * [API Definition v1.0](documents/API Definition v1.0.md)
+  * [Scheme Rules](documents/Scheme Rules.md)
   * [JSON Binding Rules](documents/JSON Binding Rules.md)
-  * [Encryption](documents/Encryption.md)
   * [PKI Best Practices](documents/PKI Best Practices.md)
+  * [Encryption](documents/Encryption.md)
 ### Change Control Board
 * [Change Control Board Overview](ccb-meetings/README.md)
   * [Issue-and-Decision-Log](ccb-meetings/Issue-and-Decision-Log.md)

assets/diagrams/sequence/figure1.plantuml

@@ -1,26 +1,25 @@
 /'*****
- 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]>
+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
 
- * Henk Kodde <henk.kodde@modusbox.com>
- --------------
- ******'/
+- Name Surname <name.surname@gatesfoundation.com>
+--------------
+******'/
 
 @startuml
 ' declaring skinparam

assets/diagrams/sequence/figure12.plantuml

@@ -1,26 +1,25 @@
 /'*****
- 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]>
+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
 
- * Henk Kodde <henk.kodde@modusbox.com>
- --------------
- ******'/
+- Name Surname <name.surname@gatesfoundation.com>
+--------------
+******'/
 
 @startuml
 

assets/diagrams/sequence/figure14.plantuml

@@ -1,26 +1,25 @@
 /'*****
- 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]>
+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
 
- * Henk Kodde <henk.kodde@modusbox.com>
- --------------
- ******'/
+- Name Surname <name.surname@gatesfoundation.com>
+--------------
+******'/
 
 @startuml
 

assets/diagrams/sequence/figure16.plantuml

@@ -1,26 +1,25 @@
 /'*****
- 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]>
+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
 
- * Henk Kodde <henk.kodde@modusbox.com>
- --------------
- ******'/
+- Name Surname <name.surname@gatesfoundation.com>
+--------------
+******'/
 
 @startuml