[Docs] Diagram visualization for foxops

.codeboarding/API_Layer.md

@@ -0,0 +1,209 @@
+```mermaid
+
+graph LR
+
+    API_Routers["API Routers"]
+
+    Application_Entrypoint["Application Entrypoint"]
+
+    Request_Response_Models["Request/Response Models"]
+
+    Incarnation_Service["Incarnation Service"]
+
+    Change_Service["Change Service"]
+
+    Dependency_Injection["Dependency Injection"]
+
+    Error_Handlers["Error Handlers"]
+
+    Logging["Logging"]
+
+    Application_Entrypoint -- "configures" --> API_Routers
+
+    Application_Entrypoint -- "configures" --> Error_Handlers
+
+    Application_Entrypoint -- "configures" --> Logging
+
+    API_Routers -- "calls" --> Incarnation_Service
+
+    API_Routers -- "calls" --> Change_Service
+
+    API_Routers -- "uses" --> Request_Response_Models
+
+    API_Routers -- "receives from" --> Dependency_Injection
+
+    API_Routers -- "sends to" --> Error_Handlers
+
+    API_Routers -- "sends to" --> Logging
+
+```
+
+
+
+[![CodeBoarding](https://img.shields.io/badge/Generated%20by-CodeBoarding-9cf?style=flat-square)](https://github.com/CodeBoarding/GeneratedOnBoardings)[![Demo](https://img.shields.io/badge/Try%20our-Demo-blue?style=flat-square)](https://www.codeboarding.org/demo)[![Contact](https://img.shields.io/badge/Contact%20us%20-%20contact@codeboarding.org-lightgrey?style=flat-square)](mailto:contact@codeboarding.org)
+
+
+
+## Details
+
+
+
+The API Layer serves as the external interface for Foxops, handling incoming HTTP requests, validating input, and routing them to the appropriate application services. It exposes the core functionalities of creating and managing incarnations and changes, adhering to the project's layered architecture.
+
+
+
+### API Routers
+
+These are the primary components of the API Layer, defining the HTTP endpoints (e.g., `/incarnations`, `/changes`) and handling incoming requests. They are responsible for initial request validation, parsing request bodies, and orchestrating the flow by delegating business logic execution to the appropriate services. They act as the direct interface for clients interacting with the Foxops system.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- <a href="https://github.com/Roche/foxops/blob/main/src/foxops/routers/incarnations.py" target="_blank" rel="noopener noreferrer">`foxops.routers.incarnations`</a>
+
+- <a href="https://github.com/Roche/foxops/blob/main/src/foxops/routers/changes.py" target="_blank" rel="noopener noreferrer">`foxops.routers.changes`</a>
+
+- <a href="https://github.com/Roche/foxops/blob/main/src/foxops/routers/auth.py" target="_blank" rel="noopener noreferrer">`foxops.routers.auth`</a>
+
+
+
+
+
+### Application Entrypoint
+
+This component is the main entry point for the Foxops application. It initializes the FastAPI application instance, configures global middleware (like error handling and logging), and registers all the API Routers, making the defined endpoints accessible to incoming HTTP requests.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- <a href="https://github.com/Roche/foxops/blob/main/src/foxops/__main__.py" target="_blank" rel="noopener noreferrer">`foxops.__main__`</a>
+
+
+
+
+
+### Request/Response Models
+
+These are Pydantic models used throughout the API Layer to define the structure, data types, and validation rules for data exchanged between clients and the API. They ensure data consistency, facilitate automatic API documentation (via OpenAPI/Swagger), and simplify data serialization/deserialization.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- `foxops.models`
+
+- <a href="https://github.com/Roche/foxops/blob/main/src/foxops/routers/changes.py" target="_blank" rel="noopener noreferrer">`foxops.routers.changes`</a>
+
+
+
+
+
+### Incarnation Service
+
+This component belongs to the Service Layer but is directly consumed by the API Routers. It encapsulates the core business logic for managing incarnations, including operations like creating new incarnations, updating existing ones, and retrieving their details. The API Routers delegate these complex operations to the Incarnation Service.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- <a href="https://github.com/Roche/foxops/blob/main/src/foxops/services/incarnation.py" target="_blank" rel="noopener noreferrer">`foxops.services.incarnation`</a>
+
+
+
+
+
+### Change Service
+
+Similar to the Incarnation Service, this component from the Service Layer handles all business logic related to managing changes within incarnations. This includes applying template updates, creating merge requests, and managing the lifecycle of changes. API Routers call this service for change-related operations.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- <a href="https://github.com/Roche/foxops/blob/main/src/foxops/services/change.py" target="_blank" rel="noopener noreferrer">`foxops.services.change`</a>
+
+
+
+
+
+### Dependency Injection
+
+This component is responsible for resolving and providing instances of required dependencies (such as service objects, repository objects, or configuration settings) to the API Routers and other components. It promotes loose coupling by allowing components to declare their dependencies without needing to know how they are constructed.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- <a href="https://github.com/Roche/foxops/blob/main/src/foxops/dependencies.py" target="_blank" rel="noopener noreferrer">`foxops.dependencies`</a>
+
+
+
+
+
+### Error Handlers
+
+This component provides a centralized mechanism for catching and handling exceptions that occur within the API Layer or deeper in the application. It ensures that errors are transformed into consistent, client-friendly HTTP responses, improving the API's usability and predictability.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- <a href="https://github.com/Roche/foxops/blob/main/src/foxops/error_handlers.py" target="_blank" rel="noopener noreferrer">`foxops.error_handlers`</a>
+
+
+
+
+
+### Logging
+
+This component provides structured logging capabilities across the application, including the API Layer. It's used to record incoming requests, outgoing responses, and any significant events or errors, which is vital for monitoring, debugging, and auditing the API's behavior.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- <a href="https://github.com/Roche/foxops/blob/main/src/foxops/logger.py" target="_blank" rel="noopener noreferrer">`foxops.logger`</a>
+
+
+
+
+
+
+
+
+
+### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)

.codeboarding/Application_Services.md

@@ -0,0 +1,133 @@
+```mermaid
+
+graph LR
+
+    Application_Services["Application Services"]
+
+    Data_Access_Layer["Data Access Layer"]
+
+    External_Git_Integration["External Git Integration"]
+
+    Git_Hoster_Integration["Git Hoster Integration"]
+
+    Core_Engine["Core Engine"]
+
+    Domain_Models["Domain Models"]
+
+    Application_Services -- "calls" --> Data_Access_Layer
+
+    Application_Services -- "calls" --> External_Git_Integration
+
+    Application_Services -- "calls" --> Git_Hoster_Integration
+
+    Application_Services -- "calls" --> Core_Engine
+
+    Application_Services -- "uses" --> Domain_Models
+
+    click Application_Services href "https://github.com/Roche/foxops/blob/main/.codeboarding//Application_Services.md" "Details"
+
+    click Data_Access_Layer href "https://github.com/Roche/foxops/blob/main/.codeboarding//Data_Access_Layer.md" "Details"
+
+    click Core_Engine href "https://github.com/Roche/foxops/blob/main/.codeboarding//Core_Engine.md" "Details"
+
+```
+
+
+
+[![CodeBoarding](https://img.shields.io/badge/Generated%20by-CodeBoarding-9cf?style=flat-square)](https://github.com/CodeBoarding/GeneratedOnBoardings)[![Demo](https://img.shields.io/badge/Try%20our-Demo-blue?style=flat-square)](https://www.codeboarding.org/demo)[![Contact](https://img.shields.io/badge/Contact%20us%20-%20contact@codeboarding.org-lightgrey?style=flat-square)](mailto:contact@codeboarding.org)
+
+
+
+## Details
+
+
+
+Analysis of the 'Application Services' component within the 'foxops' project, detailing its role, structure, and interactions with other key components like Data Access Layer, External Git Integration, Git Hoster Integration, Core Engine, and Domain Models. This component is crucial for orchestrating core business logic related to managing incarnations and changes.
+
+
+
+### Application Services [[Expand]](./Application_Services.md)
+
+This component encapsulates the core business logic and orchestrates complex workflows related to managing incarnations and changes within `foxops`. It acts as a mediator, coordinating interactions between the `Core Engine`, `Data Access Layer`, and `External Integration Layer` to fulfill business requirements. Its importance lies in centralizing and enforcing business rules, ensuring consistency, and decoupling the application's core functionality from lower-level concerns like data persistence and external API interactions.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- <a href="https://github.com/Roche/foxops/blob/main/src/foxops/services/change.py#L114-L737" target="_blank" rel="noopener noreferrer">`foxops.services.change.ChangeService` (114:737)</a>
+
+- <a href="https://github.com/Roche/foxops/blob/main/src/foxops/services/incarnation.py#L15-L44" target="_blank" rel="noopener noreferrer">`foxops.services.incarnation.IncarnationService` (15:44)</a>
+
+
+
+
+
+### Data Access Layer [[Expand]](./Data_Access_Layer.md)
+
+Handles data persistence and retrieval operations for the application.
+
+
+
+
+
+**Related Classes/Methods**: _None_
+
+
+
+### External Git Integration
+
+Provides low-level Git operations and interacts with external Git repositories.
+
+
+
+
+
+**Related Classes/Methods**: _None_
+
+
+
+### Git Hoster Integration
+
+Manages platform-specific Git operations and interactions with Git hosting platforms.
+
+
+
+
+
+**Related Classes/Methods**: _None_
+
+
+
+### Core Engine [[Expand]](./Core_Engine.md)
+
+Performs fundamental GitOps operations such as templating and patching.
+
+
+
+
+
+**Related Classes/Methods**: _None_
+
+
+
+### Domain Models
+
+Represents and manipulates business entities within the application.
+
+
+
+
+
+**Related Classes/Methods**: _None_
+
+
+
+
+
+
+
+### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)