Skip to content

Commit

Permalink
docs: updated documented interface specification (#290)
Browse files Browse the repository at this point in the history
* Picture update

* updated documented interface specification

---------

Co-authored-by: dvasunin <dmitrii.vasiunin@telekom.com>
  • Loading branch information
dvasunin and dvasunin committed May 15, 2024
1 parent 7b8e749 commit 1aaab4c
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 7 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,22 @@ In the current implementation level, self-descriptions are considered in the fol

## Architecture Overview

<br>
<img width="927" alt="image" src="https://raw.githubusercontent.com/eclipse-tractusx/portal-assets/main/docs/static/sdfactory-portal-wallet-interactions.png">
<br>
<br>
![SD-Factory - Portal interaction](../../../static/sdfactory-portal-interactions.png)


## Description of the functional interface (WHAT)

The Portal - SD Factory Interface is used to generate signed self descriptions which are stored in json ld files.
The Portal - SD Factory Interface is used to start generating process of signed self descriptions which are stored in json ld files.
The json ld file is supposed to get stored - for now normal db document storage linked to the self description owner (usually a company).
<br>
<br>

## Description of the physical interfaces (HOW)

Portal is pushing the self description via an REST API "POST" developed under the portal context.
Factory will receive the information and create the self-description with signature (with help of the wallet).
A response is getting send to the portal with an "content" section. The content section is getting stored as json file in the portal db.
Factory receives the information and transforms it to the self-description without signature. Then unsigned Self-Description is passed
to the Validation Service, which checks parameter values and signs Verifiable Credentials. This process is performed
asynchronously. The result is sent to the portal with an "content" section. The content section is getting stored as json file in the portal db.
<br>
<br>

Expand Down
Binary file added docs/static/sdfactory-portal-interactions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/static/sdfactory-portal-wallet-interactions.png
Binary file not shown.

0 comments on commit 1aaab4c

Please sign in to comment.