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 missing ALS sequence diagrams #267

Merged
Merged
35 changes: 31 additions & 4 deletions mojaloop-technical-overview/account-lookup-service/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,36 @@ _Note: The Participant Lookup use-case similarly applies to for a Payee Initiate

- [Sequence Diagram for GET Parties](als-get-parties.md)

## 4. Database Design
## 4. ALS Admin Design

### 4.1. ALS Database Schema
### 4.1. Architecture overview
![Architecture Flow Account-Lookup for Admin Get Oracles](./assets/diagrams/architecture/arch-flow-account-lookup-admin.svg)

### 4.2. Sequence diagram

#### 4.2.1 GET Oracles

- [Sequence Diagram for GET Oracles](als-admin-get-oracles.md)

#### 4.2.2 POST Oracle

- [Sequence Diagram for POST Oracle](als-admin-post-oracles.md)

#### 4.2.3 PUT Oracle

- [Sequence Diagram for PUT Oracle](als-admin-put-oracles.md)

#### 4.2.4 DELETE Oracle

- [Sequence Diagram for DELETE Oracle](als-admin-del-oracles.md)

#### 4.2.5 DELETE Endpoint Cache

- [Sequence Diagram for DELETE Endpoint Cache](als-del-endpoint.md)

## 5. Database Design

### 5.1. ALS Database Schema

#### Notes
- `partyIdType` - Values are currently seeded as per section _`7.5.6`_ [Mojaloop {{ book.importedVars.mojaloop.spec.version }} Specification]({{ book.importedVars.mojaloop.spec.uri.doc }}).
Expand All @@ -87,10 +114,10 @@ _Note: The Participant Lookup use-case similarly applies to for a Payee Initiate
* [Acount Lookup Service DBeaver ERD](./assets/entities/AccountLookupDB-schema-DBeaver.erd)
* [Acount Lookup Service MySQL Workbench Export](./assets/entities/AccountLookup-ddl-MySQLWorkbench.sql)

## 5. ALS Oracle Design
## 6. ALS Oracle Design

Detail design for the Oracle is out of scope for this document. The Oracle design and implementation is specific to each Oracle's requirements.

### 5.1. API Specification
### 6.1. API Specification

Refer to **ALS Oracle API** in the [API Specifications](../../api/README.md#als-oracle-api) section.
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# DELETE Oracles

Design for the Deletion of an Oracle Endpoint by a Hub Operator.

## Sequence Diagram

{% uml src="mojaloop-technical-overview/account-lookup-service/assets/diagrams/sequence/seq-acct-lookup-admin-del-oracle-7.3.4.puml" %}
{% enduml %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# GET Oracles

Design for getting a list of all Oracle Endpoints by the Hub Operator with the option of querying but currency and/or type.

## Sequence Diagram

{% uml src="mojaloop-technical-overview/account-lookup-service/assets/diagrams/sequence/seq-acct-lookup-admin-get-oracle-7.3.1.puml" %}
{% enduml %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# POST Oracles

Design for the creation of an Oracle Endpoint by a Hub Operator.

## Sequence Diagram

{% uml src="mojaloop-technical-overview/account-lookup-service/assets/diagrams/sequence/seq-acct-lookup-admin-post-oracle-7.3.2.puml" %}
{% enduml %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# PUT Oracles

Design for the Update of an Oracle Endpoint by a Hub Operator.

## Sequence Diagram

{% uml src="mojaloop-technical-overview/account-lookup-service/assets/diagrams/sequence/seq-acct-lookup-admin-put-oracle-7.3.3.puml" %}
{% enduml %}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# DELETE Endpoint Cache

Design for the disabling of an Oracle by the Hub Operator.

## Sequence Diagram

{% uml src="mojaloop-technical-overview/account-lookup-service/assets/diagrams/sequence/seq-acct-lookup-del-endpoint-cache-7.3.0.puml" %}
{% enduml %}
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# Sequence Diagram for POST Participants
# POST Participant

Coming soon.
Design for the creation of a Participant by a DFSP via a request.

## Sequence Diagram

{% uml src="mojaloop-technical-overview/account-lookup-service/assets/diagrams/sequence/seq-acct-lookup-post-participants-7.1.3.plantuml" %}
{% enduml %}
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading