deploy: d6f1618

eclipse-tractusx · Feb 19, 2024 · 6dfad0d · 6dfad0d
1 parent 2413524
commit 6dfad0d
Show file tree

Hide file tree

Showing 68 changed files with 667 additions and 58 deletions.
diff --git a/docs/administration/administration-guide.html b/docs/administration/administration-guide.html
@@ -1679,7 +1679,7 @@ <h2 id="_troubleshooting">Troubleshooting</h2>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-02-15 13:38:40 UTC
+Last updated 2024-02-19 09:57:06 UTC
 </div>
 </div>
 </body>

diff --git a/docs/administration/backend-configuration.html b/docs/administration/backend-configuration.html
@@ -1168,7 +1168,7 @@ <h3 id="_pgadmin4_ingress_enabled">&lt;pgadmin4.ingress.enabled&gt;</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-02-15 13:38:40 UTC
+Last updated 2024-02-19 09:57:06 UTC
 </div>
 </div>
 </body>

diff --git a/docs/administration/configuration.html b/docs/administration/configuration.html
@@ -1322,7 +1322,7 @@ <h3 id="_retrieve_wallet_configuration">Retrieve Wallet Configuration</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-02-15 13:38:40 UTC
+Last updated 2024-02-19 09:57:06 UTC
 </div>
 </div>
 </body>

diff --git a/docs/administration/frontend-configuration.html b/docs/administration/frontend-configuration.html
@@ -519,7 +519,7 @@ <h4 id="_readinessprobe">&lt;readinessProbe&gt;</h4>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-02-15 13:38:40 UTC
+Last updated 2024-02-19 09:57:06 UTC
 </div>
 </div>
 </body>

diff --git a/docs/administration/installation.html b/docs/administration/installation.html
@@ -750,7 +750,7 @@ <h2 id="_deployment_using_argocd">Deployment using ArgoCD</h2>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-02-15 13:38:40 UTC
+Last updated 2024-02-19 09:57:06 UTC
 </div>
 </div>
 </body>

diff --git a/docs/administration/portal-configuration.html b/docs/administration/portal-configuration.html
@@ -580,7 +580,7 @@ <h2 id="_retrieve_wallet_configuration">Retrieve Wallet Configuration</h2>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-02-15 13:38:40 UTC
+Last updated 2024-02-19 09:57:06 UTC
 </div>
 </div>
 </body>

diff --git a/docs/administration/system-overview.html b/docs/administration/system-overview.html
@@ -689,7 +689,7 @@ <h2 id="_rights_and_role_matrix_of_trace_x">Rights and Role matrix of Trace-X</h
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-02-15 13:38:40 UTC
+Last updated 2024-02-19 09:57:06 UTC
 </div>
 </div>
 </body>

diff --git a/docs/administration/troubleshooting.html b/docs/administration/troubleshooting.html
@@ -448,7 +448,7 @@ <h1>Troubleshooting</h1>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-02-15 13:38:40 UTC
+Last updated 2024-02-19 09:57:06 UTC
 </div>
 </div>
 </body>

diff --git a/docs/api-specification/api-specification.html b/docs/api-specification/api-specification.html
@@ -503,7 +503,7 @@ <h1>Trace-X API</h1>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-02-15 13:38:40 UTC
+Last updated 2024-02-19 09:57:06 UTC
 </div>
 </div>
 </body>

diff --git a/docs/api-specification/api.html b/docs/api-specification/api.html
@@ -455,7 +455,7 @@ <h1>Trace-X API</h1>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-02-15 13:38:40 UTC
+Last updated 2024-02-19 09:57:06 UTC
 </div>
 </div>
 </body>

diff --git a/docs/arc42.md b/docs/arc42.md
@@ -256,6 +256,7 @@ Component Diagram
 | **AssetsController** | The **AssetsController** provides a REST Interface for retrieving the parts/assets information. |
 | **DashboardController** | The **DashboardController** provides a REST Interface for retrieving overall statistics displayed on a dashboard screen. |
 | **RegistryController** | The **RegistryController** provides a REST Interface for retrieving the data from parts registry. |
+| **ImportController** | The **ImportController** provides a REST Interface for importing assets and publishing them in the Catena-X network. |
 | **AssetRepository** | The **AssetRepository** is a component responsible for storing and getting assets from database. |
 | **BPNRepository** | The **BPNRepository** is a component which stores BPN -> company name mappings. |
 | **NotificationsRepository** | The **NotificationsRepository** is a component responsible for storing and holding status of sent/received notifications |
@@ -381,6 +382,20 @@ The backend is able to persist the data in the DTR / EDC and allows to use IRS f
 
 ```
 
+TODO: Add all scenarios for data-provisioning
+
+## Scenario 1: Receive import report
+
+This section describes what happens when the user wants to get a report of the imported assets associated to a importJobId.
+In this example, the user requests an import report.
+
+##### Overview
+
+When a user requests an import report, TraceX-FOSS checks if the user has an adequate role ('ROLE_ADMIN', 'ROLE_SUPERVISOR').
+If yes, then the endpoint returns an import report to the given importJobId.
+
+If the importJobId is not known to Trace-X, an HTTP 404 error is returned.
+
 ## Deployment view
 
 ## Cross-cutting concepts

diff --git a/docs/arc42/.asciidoctor/diagram/import-report-receive.svg.cache b/docs/arc42/.asciidoctor/diagram/import-report-receive.svg.cache
@@ -0,0 +1 @@
+{"checksum":"plantuml-md5-013f4ad262aaba55cb0aad8468302d9f","options":{"size_limit":"4096"},"width":1732,"height":542}
diff --git a/docs/arc42/architecture-constraints/import-report-receive.svg b/docs/arc42/architecture-constraints/import-report-receive.svg
diff --git a/docs/arc42/architecture-constraints/index.html b/docs/arc42/architecture-constraints/index.html
@@ -582,7 +582,7 @@ <h2 id="_development_conventions">Development Conventions</h2>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-02-15 13:38:40 UTC
+Last updated 2024-02-19 09:57:06 UTC
 </div>
 </div>
 </body>

diff --git a/docs/arc42/building-block-view/full.html b/docs/arc42/building-block-view/full.html
@@ -542,6 +542,10 @@ <h3 id="_component_description_2">Component description</h3>
 <td class="tableblock halign-left valign-top"><p class="tableblock">The <strong>RegistryController</strong> provides a REST Interface for retrieving the data from parts registry.</p></td>
 </tr>
 <tr>
+<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>ImportController</strong></p></td>
+<td class="tableblock halign-left valign-top"><p class="tableblock">The <strong>ImportController</strong> provides a REST Interface for importing assets and publishing them in the Catena-X network.</p></td>
+</tr>
+<tr>
 <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>AssetRepository</strong></p></td>
 <td class="tableblock halign-left valign-top"><p class="tableblock">The <strong>AssetRepository</strong> is a component responsible for storing and getting assets from database.</p></td>
 </tr>
@@ -565,7 +569,7 @@ <h3 id="_component_description_2">Component description</h3>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-02-15 13:38:40 UTC
+Last updated 2024-02-19 09:57:06 UTC
 </div>
 </div>
 </body>

diff --git a/docs/arc42/building-block-view/index.html b/docs/arc42/building-block-view/index.html
@@ -469,7 +469,7 @@ <h2 id="_chapters">Chapters</h2>
 </div>
 <div id="footer">
 <div id="footer-text">
-Last updated 2024-02-15 13:38:40 UTC
+Last updated 2024-02-19 09:57:06 UTC
 </div>
 </div>
 </body>