zwitschi
4dea0a9ae1
- Introduced SQLAlchemy models for user management, project management, financial inputs, and pricing configuration. - Created navigation metadata tables for sidebar and top-level menus. - Cataloged enumerations used across ORM models and Pydantic schemas. - Documented Pydantic schemas for API request/response validation, including authentication, project, scenario, import, and export schemas. - Added monitoring and auditing tables for performance metrics and import/export logs. - Updated security documentation to reflect changes in data model references.
24 lines
1.8 KiB
Markdown
24 lines
1.8 KiB
Markdown
# Data Model Overview
|
||
|
||
Calminer’s data model spans several distinct layers: persisted ORM entities, Pydantic schemas used by the API, navigation metadata, shared enumerations, and operational telemetry tables. To make the material easier to scan, the original monolithic document has been split into focused reference pages.
|
||
|
||
## Reference Structure
|
||
|
||
- [SQLAlchemy Models](./02_data_model/01_sqlalchemy_models.md) — Domain entities that persist projects, scenarios, pricing configuration, snapshots, and supporting records.
|
||
- [Navigation Metadata](./02_data_model/02_navigation.md) — Sidebar and menu configuration tables plus seeding/runtime notes.
|
||
- [Enumerations](./02_data_model/03_enumerations.md) — Shared enum definitions used across ORM models and schemas.
|
||
- [Pydantic Schemas](./02_data_model/04_pydantic.md) — Request/response models, import/export payloads, and validation nuances.
|
||
- [Monitoring and Auditing](./02_data_model/05_monitoring.md) — Telemetry and audit tables supporting observability.
|
||
|
||
Each detailed page retains the original headings and tables, so existing anchors and references can migrate with minimal disruption.
|
||
|
||
## How to Use This Overview
|
||
|
||
- Start with the SQLAlchemy reference when you need to understand persistence concerns or relationships between core domain objects.
|
||
- Jump to the Pydantic schemas document when adjusting API payloads or validation logic.
|
||
- Consult the enumerations list before introducing new enum values to keep backend and frontend usage aligned.
|
||
- Review the navigation metadata page when seeding or modifying the application sidebar.
|
||
- Use the monitoring and auditing section to track telemetry fields that drive dashboards and compliance reporting.
|
||
|
||
Cross-links between these documents mirror the previous inline references. Update any external links to point at the new files during your next documentation touchpoint.
|