eclipse-tractusx · tunacicek · Mar 1, 2024 · Mar 1, 2024
diff --git a/docs/3-system-scope-and-context.md b/docs/3-system-scope-and-context.md
@@ -2,7 +2,14 @@
 
 ### Business Context
 
-![](media/BusinessContext.PNG)
+```mermaid
+graph LR
+    Consumer_App[Consumer App] -- "requests BPN for 'oen-123'" --> BPN_Discovery
+    Keycloak -- "administrates the authorization token" <--> BPN_Discovery[BPN Discovery]
+    BPN_Discovery -- "responses with BPML_0127EST" --> Consumer_App
+    BPN_Discovery -- "registers himself at startup" --> Discovery_Finder[Discovery Finder]
+    Data_Provider[Data Provider] -- "register his types and keys" --> BPN_Discovery
+```
 
 | Neighbor         | Description                                  |
 |------------------|----------------------------------------------|
@@ -13,8 +20,14 @@
 
 
 ### Technical Context
-
-![](media/TechnicalContext.PNG)
+```mermaid
+graph LR
+    Consumer_App[Consumer App] -- "request via post http" --> BPN_Discovery
+    BPN_Discovery -- "response via post http" --> Consumer_App
+    Keycloak -- "administrates the authorization token" <--> BPN_Discovery[BPN Discovery]
+    BPN_Discovery -- "reuqest post via http (registers himself at startup)" --> Discovery_Finder[Discovery Finder]
+    Data_Provider[Data Provider] -- "request via post http (register his types and key)" --> BPN_Discovery
+```
 
 | Neighbor         | Description                                                              |
 |------------------|--------------------------------------------------------------------------|

diff --git a/docs/4-runtime-view.md b/docs/4-runtime-view.md
@@ -1,8 +1,25 @@
 ## 4 Runtime-view
 
 ### Search request
-
-![](media/SearchFlow.PNG)
+```mermaid
+sequenceDiagram
+    participant ConsumerApp as ConsumerApp
+    participant BpnDiscoveryApiDelegate as BpnDiscovery ApiDelegate
+    participant BpnDiscoveryMapper as BpnDiscovery Mapper
+    participant BpnDiscoveryService as BpnDiscovery Service
+    participant BpnDiscoveryRepository as BpnDiscovery Repository
+    participant BpnDiscoveryCollectionDto as BpnDiscovery CollectionDto
+
+    ConsumerApp->>+BpnDiscoveryApiDelegate: post /api/administration/connectors/bpnDiscovery/search
+    BpnDiscoveryApiDelegate->>+BpnDiscoveryMapper: fromSearchList ApiDto()
+    BpnDiscoveryMapper->>+BpnDiscoveryApiDelegate: List<TypeKeys IdentifierDto
+    BpnDiscoveryMapper->>+BpnDiscoveryService: findBpnDiscoveries()
+    BpnDiscoveryService->>+BpnDiscoveryRepository: findBpnDiscoveriesByTypeAndKeyIn()
+    BpnDiscoveryRepository->>-BpnDiscoveryService: List<TypeKeys IdentifierDto>
+    BpnDiscoveryService->>+BpnDiscoveryCollectionDto: BpnDiscoveryCollectionDto.builder() .bpns(foundBpnDiscoveries) .build()
+    BpnDiscoveryCollectionDto ->>-BpnDiscoveryApiDelegate: BpnDiscoveryCollectionDto
+    BpnDiscoveryApiDelegate->>-ConsumerApp: ResponseEntity<BpnCollection>
+```
 
 1.  The ConsumerApp sends a request with a given type number and type to
     BpnDiscoveryApiDelegate.
@@ -23,9 +40,27 @@
 
 
 ### Add request
-
-![](media/AddFlow.PNG)
-
+```mermaid
+sequenceDiagram
+    participant DataProvider as Data Provider
+    participant BpnDiscoveryApiDelegate as BpnDiscovery ApiDelegate
+    participant BpnDiscoveryService as BpnDiscovery Service
+    participant BpnDiscoveryMapper as BpnDiscovery Mapper
+    participant ClientAware as ClientAware
+    participant BpnDiscoveryValidator as BpnDiscovery Validator
+    participant BpnDiscoveryRepository as BpnDiscovery Repository
+
+    DataProvider ->>+ BpnDiscoveryApiDelegate: POST /api/administration/connectors/bpnDiscovery
+    BpnDiscoveryApiDelegate ->>- BpnDiscoveryService: save()
+    BpnDiscoveryService ->>+ BpnDiscoveryMapper: fromApi()
+    BpnDiscoveryMapper ->>- BpnDiscoveryService: BpnDiscovoery
+    BpnDiscoveryService ->>+ ClientAware: getBpn()
+    ClientAware ->>- BpnDiscoveryService: BpnDiscovery
+    BpnDiscoveryService ->>+ BpnDiscoveryValidator: validate()
+    BpnDiscoveryService ->>+ BpnDiscoveryRepository: save()
+    BpnDiscoveryService ->>+ BpnDiscoveryApiDelegate: BpnDiscovery
+    BpnDiscoveryApiDelegate ->>+ DataProvider: ResponseEntity<Bpn>
+```
 
 1.  The Data Provider sends a request with one given type number and
     type to BpnDiscoveryApiDelegate.
@@ -49,9 +84,28 @@
 
 
 ### Add batch request
-
-![](media/AddBatchFlow.PNG)
-
+```mermaid
+sequenceDiagram
+    participant DataProvider as Data Provider
+    participant BpnDiscoveryApiDelegate as BpnDiscovery ApiDelegate
+    participant BpnDiscoveryMapper as BpnDiscovery Mapper
+    participant BpnDiscoveryService as BpnDiscovery Service
+    participant ClientAware as ClientAware
+    participant BpnDiscoveryValidator as BpnDiscovery Validator
+    participant BpnDiscoveryRepository as BpnDiscovery Repository
+
+    DataProvider ->>+ BpnDiscoveryApiDelegate: POST /api/administration/connectors/bpnDiscovery/batch
+    BpnDiscoveryApiDelegate ->>+ BpnDiscoveryMapper: fromListApiDto()
+    BpnDiscoveryMapper ->>- BpnDiscoveryApiDelegate: List<BpnDiscovery>
+    BpnDiscoveryApiDelegate ->>+ BpnDiscoveryService: saveBatch()
+    BpnDiscoveryService ->>+ BpnDiscoveryService: save()
+    BpnDiscoveryService ->>+ ClientAware: getBpn()
+    ClientAware ->>- BpnDiscoveryService: BpnDiscovery
+    BpnDiscoveryService ->>+ BpnDiscoveryValidator: validate()
+    BpnDiscoveryService ->>+ BpnDiscoveryRepository: save()
+    BpnDiscoveryService ->>- BpnDiscoveryApiDelegate: List<BatchResultDto>
+    BpnDiscoveryApiDelegate ->>- DataProvider: ResponseEntity <List<TypeKeyPairBatchResult>>
+```
 
 1.  The Data Provider sends a request with multiple given type numbers
     for one type to BpnDiscoveryApiDelegate.
@@ -78,8 +132,25 @@
 
 
 ### Delete request
-
-![](media/DeleteFlow.PNG)
+```mermaid
+sequenceDiagram
+    participant DataProvider as Data Provider
+    participant BpnDiscoveryApiDelegate as BpnDiscovery ApiDelegate
+    participant BpnDiscoveryService as BpnDiscovery Service
+    participant UuidUtils as Uuid Util
+    participant ClientAware as ClientAware
+    participant BpnDiscoveryRepository as BpnDiscovery Repository
+    participant ClientAware as ClientAware
+
+    DataProvider ->>+ BpnDiscoveryApiDelegate: DELETE /api/administration/connectors/bpnDiscovery/{resourceId}
+    BpnDiscoveryApiDelegate ->>+ BpnDiscoveryService: delete()
+    BpnDiscoveryService ->>+ UuidUtils: validateUUID()
+    BpnDiscoveryService ->>+ BpnDiscoveryRepository: findBpnDiscoveryByResourceId()
+    BpnDiscoveryRepository ->>- BpnDiscoveryService: BpnDiscovery
+    BpnDiscoveryService ->>+ ClientAware: validateBpnOwnership()
+    BpnDiscoveryService ->>+ BpnDiscoveryRepository: deleteById()
+    BpnDiscoveryApiDelegate ->>- DataProvider: ResponseEntity<Void>
+```
 
 1.  The Data Provider sends a request to delete an entry to
     BpnDiscoveryApiDelegate.

diff --git a/docs/documentation.md b/docs/documentation.md
@@ -21,49 +21,6 @@ There are two actors who interact with this service.
 ## BPN Discovery Api
 The BPN Discovery provides a Swagger-Interface for all endpoints: https://semantics.int.demo.catena-x.net/bpndiscovery/swagger-ui/index.html
 
-#### Search request
-![](media/Search_BPN.PNG)
-
-**Request body**
-
-![](media/Search_Request_BPn.PNG)
-
-**Response**
-
-![](media/Response_Search_BPN.PNG)
-
-#### Add request
-![](media/Add_BPN.PNG)
-
-**Request body**
-
-![](media/Add_Request_BPN.PNG)
-
-**Response**
-
-![](media/Respnse_add_BPN.PNG)
-#### Add batch request
-![](media/Add_Batch_BPN.PNG)
-
-**Request**
-
-![](media/add_batch_request.PNG)
-
-**Response**
-
-![](media/add_batch_response_BPN.PNG)
-
-#### Delete request
-![](media/Delete_BPN.PNG)
-
-**ResourceId**
-
-![](media/resourceID_BPN.PNG)
-
-**Response**
-
-![](media/Delete_Response_BPN.PNG)
-
 ## Authentication & Authorization
 The service is secured by a OAuth2 compliant authorization. Every API call has to provide a
 valid Bearer Token. Authorization is provided by a role based access. These roles are possible:

diff --git a/docs/media/AddBatchFlow.PNG b/docs/media/AddBatchFlow.PNG
diff --git a/docs/media/AddFlow.PNG b/docs/media/AddFlow.PNG
diff --git a/docs/media/Add_BPN.PNG b/docs/media/Add_BPN.PNG
diff --git a/docs/media/Add_Batch_BPN.PNG b/docs/media/Add_Batch_BPN.PNG
diff --git a/docs/media/Add_Request_BPN.PNG b/docs/media/Add_Request_BPN.PNG
diff --git a/docs/media/BusinessContext.PNG b/docs/media/BusinessContext.PNG
diff --git a/docs/media/DeleteFlow.PNG b/docs/media/DeleteFlow.PNG
diff --git a/docs/media/Delete_BPN.PNG b/docs/media/Delete_BPN.PNG
diff --git a/docs/media/Delete_Response_BPN.PNG b/docs/media/Delete_Response_BPN.PNG
diff --git a/docs/media/Respnse_add_BPN.PNG b/docs/media/Respnse_add_BPN.PNG
diff --git a/docs/media/Response_Search_BPN.PNG b/docs/media/Response_Search_BPN.PNG
diff --git a/docs/media/SearchFlow.PNG b/docs/media/SearchFlow.PNG
diff --git a/docs/media/Search_BPN.PNG b/docs/media/Search_BPN.PNG
diff --git a/docs/media/Search_Request_BPn.PNG b/docs/media/Search_Request_BPn.PNG
diff --git a/docs/media/TechnicalContext.PNG b/docs/media/TechnicalContext.PNG
diff --git a/docs/media/add_batch_request.PNG b/docs/media/add_batch_request.PNG
diff --git a/docs/media/add_batch_response_BPN.PNG b/docs/media/add_batch_response_BPN.PNG