diff --git a/docs/technical-documentation/architecture/Architecture Constraints.md b/docs/technical-documentation/architecture/Architecture Constraints.md index 3d19338..d0d5be8 100644 --- a/docs/technical-documentation/architecture/Architecture Constraints.md +++ b/docs/technical-documentation/architecture/Architecture Constraints.md @@ -2,7 +2,7 @@ ## General -- This project is an readonly API project, there is no plan to implement an UI yet. +- This project provides an readonly API, there is no plan to implement an UI yet. - Run anywhere: can be deployed as a docker image, e. g. on Kubernetes (platform-independent, cloud, on prem or local). diff --git a/docs/technical-documentation/architecture/Whitebox Overall System.md b/docs/technical-documentation/architecture/Whitebox Overall System.md index 43c2054..a672578 100644 --- a/docs/technical-documentation/architecture/Whitebox Overall System.md +++ b/docs/technical-documentation/architecture/Whitebox Overall System.md @@ -4,12 +4,30 @@ In the following image you see the overall system overview of the Policy Hub -TODO (PS): add image for system view +```mermaid +flowchart LR + + C(Customer) + ING(Ingress) + PH(Policy Hub API) + PHD[("Postgres Database \n \n (Data created with \n application seeding)")] + + subgraph Policy-Hub Product + ING + PH + PHD + end + + C-->|"Authentication & Authorization Data \n (Using JWT)"|ING + ING-->|"Forward Request"|PH + PH-->|"Read policies, use cases, \n credential types, policy rules"|PHD + +``` ## NOTICE This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). - SPDX-License-Identifier: Apache-2.0 -- SPDX-FileCopyrightText: 2021-2023 Contributors to the Eclipse Foundation +- SPDX-FileCopyrightText: 2024 Contributors to the Eclipse Foundation - Source URL: https://github.com/eclipse-tractusx/policy-hub diff --git a/docs/technical-documentation/authentication/authentication.md b/docs/technical-documentation/authentication/authentication.md index 9ed3a9d..a083181 100644 --- a/docs/technical-documentation/authentication/authentication.md +++ b/docs/technical-documentation/authentication/authentication.md @@ -2,7 +2,7 @@ The authentication process for the Policy Hub involves interaction with the central IAM (Identity and Access Management). The configuration for IAM can be customized either locally during development through secrets or within the chart for the Docker image. -Currently, the Policy Hub performs a basic validation by checking for a valid token in the request. However, it's important to note that no permission checks are conducted at this stage. +Currently, the Policy Hub performs a basic validation by checking for a valid token with a configurable Audience in the request. However, it's important to note that no permission checks are conducted at this stage. ## NOTICE diff --git a/docs/technical-documentation/dev-process/Enumeration Handling.md b/docs/technical-documentation/dev-process/Enumeration Handling.md index e77f773..53eb4eb 100644 --- a/docs/technical-documentation/dev-process/Enumeration Handling.md +++ b/docs/technical-documentation/dev-process/Enumeration Handling.md @@ -12,7 +12,6 @@ List of used enums in the policy hub application that are stored in the database ### Add Enums New enums can get added easily be enhancing the enumeration table (via the seeding data). With the next deployment; the new enum is getting auto deployed to the respective env. -Since enums have an enhanced impact on the system functionality; it is mandatorily needed to test (FE wise) the impacted screens / flows before releasing new enums. It is likely that the enum has an enhanced impact on the user journey / flow and break the system if not well tested. ### Change Enums diff --git a/docs/developer/Technical-Documentation/requests/example-requests.md b/docs/technical-documentation/requests/example-requests.md similarity index 100% rename from docs/developer/Technical-Documentation/requests/example-requests.md rename to docs/technical-documentation/requests/example-requests.md diff --git a/docs/developer/Technical-Documentation/requests/policy-hub.postman_collection.json b/docs/technical-documentation/requests/policy-hub.postman_collection.json similarity index 100% rename from docs/developer/Technical-Documentation/requests/policy-hub.postman_collection.json rename to docs/technical-documentation/requests/policy-hub.postman_collection.json