Skip to content

Commit

Permalink
Feature/markdown documents 9.2.1 - Logical Data Module.md (#53)
Browse files Browse the repository at this point in the history
* - 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.

* Corrected reference in Encryption.md
Created PKI Best Practices in markdown
Recreated figure1-platforms-layout in drawio
Updated summary file for gitbooks
Updated version to 9.0.0

* Version update to 9.1.0

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

* - Created "Logical Data Module" in markdown.
- Update README.md to reference markdown document "Logical Data Module".
- Update SUMMARY.md to include markdown document "Logical Data Module" in GitBooks.
- Release to 9.2.1

Co-authored-by: Sam <[email protected]>
  • Loading branch information
HenkKodde and Sam authored Feb 26, 2020
1 parent 650aa7b commit 14b9a0d
Show file tree
Hide file tree
Showing 5 changed files with 2,545 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ The Open API for FSP Interoperability Specification includes the following docum
Information is shared in accordance with **Creative Commons Licensing**.

## Logical Data Model
[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.
[This document](https://github.com/mojaloop/mojaloop-specification/blob/master/documents/Logical%20Data%20Model.md) 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/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.
Expand Down
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
### Documents
* [Mojaloop Specifications Overview](README.md)
* [Glossary](documents/Glossary.md)
* [Logical data Module](documents/Logical Data Module.md)
* [Generic Transaction Patterns](documents/Generic Transaction Patterns.md)
* [Use Cases](documents/Use Cases.md)
* [API Definition v1.0](documents/API Definition v1.0.md)
Expand Down
Loading

0 comments on commit 14b9a0d

Please sign in to comment.