Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add sequence diagram section to docs/README; use PlantUML proxy to render svg #51

Merged
merged 3 commits into from
Mar 8, 2021
Merged

Conversation

millerabel
Copy link
Member

@millerabel millerabel commented Mar 8, 2021

Added sequence diagrams section to docs/README with links to new ...md file for each sequence diagram. Created initial versions of the sequence diagram md files with link through PlantUML proxy to the raw sequence diagram .puml files in docs/sequence/...

Corrected color name errors in PISPTransactionAPI.puml that prevented rendering.

*** I had previously pushed these two commits erroneously to Mojaloop -> Master. I reset the head on Mojaloop -> Master and the commits are now incoming through a pull request from my fork, as I originally intended.

…e diags

Add Sequence Diagrams section to the Docs/README.md; create a new sequence diagram .md file for each sequence diagram referenced from README; incorporate PlantUML proxy service to render the sequence diagrams within each new sequence page.
@CLAassistant
Copy link

CLAassistant commented Mar 8, 2021

CLA assistant check
All committers have signed the CLA.

@millerabel millerabel requested a review from lewisdaly March 8, 2021 02:38
@eoln eoln changed the base branch from master to feat/2060_sdk_request March 8, 2021 07:29
@eoln eoln self-requested a review March 8, 2021 07:29
@eoln eoln merged commit ec9d504 into mojaloop:feat/2060_sdk_request Mar 8, 2021
lewisdaly pushed a commit that referenced this pull request Mar 11, 2021
* chore: update deps

* docs: UML sequence for P2PTransaction

* chore: bring back deps

* docs: update UML sequence for P2PTransaction

* doc: rename state to pendingVerifyAuthorization, add question about notification of transactionRequestState:ACCEPTED

* Add sequence diagram section to docs/README; use PlantUML proxy to render svg (#51)

* Sequence diagrams linked in README; PlantUML proxy render for sequence diags

Add Sequence Diagrams section to the Docs/README.md; create a new sequence diagram .md file for each sequence diagram referenced from README; incorporate PlantUML proxy service to render the sequence diagrams within each new sequence page.

* Update PISPTransactionApi.puml

Fix color names

Co-authored-by: Paweł Marzec <[email protected]>

* fix: #Light->#LightBlue

* doc: drop AUTH-SERVICE in favor of abstract DFSP backend

* chore: regenerate package-lock.json

* chore: update deps

* doc: add error scenario for failed Authorization

* doc: add png

* doc: fix issues

Co-authored-by: Miller Abel <[email protected]>
eoln added a commit that referenced this pull request Mar 15, 2021
* chore: update deps

* docs: UML sequence for P2PTransaction

* chore: bring back deps

* docs: update UML sequence for P2PTransaction

* doc: rename state to pendingVerifyAuthorization, add question about notification of transactionRequestState:ACCEPTED

* Add sequence diagram section to docs/README; use PlantUML proxy to render svg (#51)

* Sequence diagrams linked in README; PlantUML proxy render for sequence diags

Add Sequence Diagrams section to the Docs/README.md; create a new sequence diagram .md file for each sequence diagram referenced from README; incorporate PlantUML proxy service to render the sequence diagrams within each new sequence page.

* Update PISPTransactionApi.puml

Fix color names

Co-authored-by: Paweł Marzec <[email protected]>

* fix: #Light->#LightBlue

* doc: drop AUTH-SERVICE in favor of abstract DFSP backend

* chore: regenerate package-lock.json

* chore: update deps

* doc: add error scenario for failed Authorization

* doc: add png

* doc: fix issues

* refactor: drop dfspId from config, use plural name for requests

* refactor: use plural for requests, drop dfspId, add TODOS

* refactor: drop dfspId from config

* feat: sdk-requests to group all sdk related requests

* test: add requestToPay scenario

* doc: update plurar Requests

* refactor: rename SDKRequest to SDKRequests

* refactor: new set of requests accessors for RequestToolkit

* refactor: pispTransactionModel to use SDKRequests

* refactor: InboundAuthorizationsModel to use PISPBackendRequests

* refactor: to use new requests

* test: fix broken units

* refactor: inbound transactions

* test: fix broken mock of RequestToolkit

* feat: new config params and fixing integration tests

* fix: url paths

* test: fix warning about HelloGet handler

* chore: replace sdk-scheme-adapter master/pisp docker image with master one

* ci: add ttk to wait4

* ci: add sdk-scheme-adapter to wait4

* test: fix port

* doc: update PISPTransaction svg file

* docs: add some todos

* refactor: rename endpoint to match uml sequences

Co-authored-by: Miller Abel <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants