From 5cd31765ddecb1320dd3e7b5cf7ec6b03ce59a3f Mon Sep 17 00:00:00 2001
From: imilev <imilev@ethz.ch>
Date: Sat, 5 Jul 2025 02:17:57 +0300
Subject: [PATCH] Added high-level diagrams

---
 .codeboarding/on_boarding.md | 159 +++++++++++++++++++++++++++++++++++
 1 file changed, 159 insertions(+)
 create mode 100644 .codeboarding/on_boarding.md

diff --git a/.codeboarding/on_boarding.md b/.codeboarding/on_boarding.md
new file mode 100644
index 0000000..6c8b878
--- /dev/null
+++ b/.codeboarding/on_boarding.md
@@ -0,0 +1,159 @@
+```mermaid
+
+graph LR
+
+    Root_Package["Root Package"]
+
+    Asynchronous_Client["Asynchronous Client"]
+
+    Synchronous_Client["Synchronous Client"]
+
+    Data_Models["Data Models"]
+
+    Exception_Handling["Exception Handling"]
+
+    Retry_Logic["Retry Logic"]
+
+    Root_Package -- "Exposes" --> Synchronous_Client
+
+    Root_Package -- "Exposes" --> Asynchronous_Client
+
+    Asynchronous_Client -- "Utilizes" --> Retry_Logic
+
+    Asynchronous_Client -- "Processes" --> Data_Models
+
+    Asynchronous_Client -- "Raises" --> Exception_Handling
+
+    Synchronous_Client -- "Delegates to" --> Asynchronous_Client
+
+    Synchronous_Client -- "Returns/Accepts" --> Data_Models
+
+```
+
+
+
+[![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 `foxops-client-python` project is structured as a Python API Client Library (SDK), adhering to a clear separation of concerns. Its architecture facilitates robust and user-friendly interaction with the Foxops API, supporting both synchronous and asynchronous operations, resilient request handling, and well-defined data structures.
+
+
+
+### Root Package
+
+The top-level entry point and orchestrator for the entire client library. It aggregates and exposes the core client functionalities, making them accessible to external applications.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- `foxops_client` (1:1)
+
+
+
+
+
+### Asynchronous Client
+
+The primary component for all non-blocking, asynchronous interactions with the Foxops API. It manages HTTP requests, applies retry mechanisms, and processes API responses into defined data models or raises specific exceptions.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- <a href="https://github.com/Roche/foxops-client-python/blob/main/src/foxops_client/client_async.py#L1-L1" target="_blank" rel="noopener noreferrer">`foxops_client.client_async` (1:1)</a>
+
+
+
+
+
+### Synchronous Client
+
+Provides a blocking, synchronous interface for API interactions. It acts as a facade, delegating all actual API calls to the `Asynchronous Client` and blocking execution until the asynchronous operation completes.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- <a href="https://github.com/Roche/foxops-client-python/blob/main/src/foxops_client/client_sync.py#L1-L1" target="_blank" rel="noopener noreferrer">`foxops_client.client_sync` (1:1)</a>
+
+
+
+
+
+### Data Models
+
+Defines the structured Python data types (DTOs) used for representing entities exchanged with the Foxops API. These models include methods for deserializing JSON API responses into Python objects, ensuring type safety and consistency.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- <a href="https://github.com/Roche/foxops-client-python/blob/main/src/foxops_client/types.py#L1-L1" target="_blank" rel="noopener noreferrer">`foxops_client.types` (1:1)</a>
+
+
+
+
+
+### Exception Handling
+
+Centralizes custom exception classes that represent specific API errors (e.g., `AuthenticationError`, `IncarnationDoesNotExistError`). This module provides a structured way to communicate API-related issues to the client application.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- <a href="https://github.com/Roche/foxops-client-python/blob/main/src/foxops_client/exceptions.py#L1-L1" target="_blank" rel="noopener noreferrer">`foxops_client.exceptions` (1:1)</a>
+
+
+
+
+
+### Retry Logic
+
+Implements strategies for automatically retrying failed API requests, enhancing the client's robustness against transient network issues or temporary service unavailability. It encapsulates the retry policy, such as exponential backoff or maximum retry attempts.
+
+
+
+
+
+**Related Classes/Methods**:
+
+
+
+- <a href="https://github.com/Roche/foxops-client-python/blob/main/src/foxops_client/retries.py#L1-L1" target="_blank" rel="noopener noreferrer">`foxops_client.retries` (1:1)</a>
+
+
+
+
+
+
+
+
+
+### [FAQ](https://github.com/CodeBoarding/GeneratedOnBoardings/tree/main?tab=readme-ov-file#faq)
\ No newline at end of file