Files
headquarter/apps/api/src/schemas/system/.pi-map.md
T

1.1 KiB

apps/api/src/schemas/system

dir: apps/api/src/schemas/system

index: apps/api/src/schemas/system/.pi-map.index.md

role

Provides Pydantic data models for system health monitoring API responses, enabling standardized health check serialization across the API.

files

  • __init__.py | Re-exports health-related schema classes from a submodule to provide a unified interface for the system schemas module. | dep: src.schemas.system.health
  • health.py | Defines Pydantic data models for health check API responses including database, disk, and overall system health metrics. | exp: class:DatabaseHealth, class:DiskHealth, class:HealthChecks, class:HealthResponse, class:DatabaseHealthResponse | dep: pydantic

arch

Simple submodule-based schema organization with explicit re-exports in __init__.py following a flat namespace pattern for cleaner imports.

tags

health, database, response, system, disk, schemas, init, pydantic

symbols

  • DatabaseHealth
  • DiskHealth
  • HealthChecks
  • HealthResponse
  • DatabaseHealthResponse

workflows

  • change system behavior read: __init__.py, health.py

dirty