Skip to content

presentation.routers.system

src.presentation.routers.system

System router for non-versioned application endpoints.

Provides external-facing system endpoints that are not part of the versioned API contract, such as root, health, and configuration.

These endpoints are intentionally lightweight and side-effect free to support health checks and basic diagnostics.

Classes

Functions

root async 

root() -> dict[str, str]

Root endpoint - basic health/status check.

Returns:

Type Description
dict[str, str]

dict[str, str]: Welcome message with API status and version.
Source code in src/presentation/routers/system.py 
26
27
28
29
30
31
32
33
34
35
36
37
@system_router.get("/")
async def root() -> dict[str, str]:
    """Root endpoint - basic health/status check.

    Returns:
        dict[str, str]: Welcome message with API status and version.
    """
    return {
        "message": "Dashtam API",
        "status": "operational",
        "version": settings.app_version,
    }

health async 

health() -> dict[str, str]

Health check endpoint for monitoring and load balancers.

Returns:

Type Description
dict[str, str]

dict[str, str]: Health status indicator.
Source code in src/presentation/routers/system.py 
40
41
42
43
44
45
46
47
@system_router.get("/health")
async def health() -> dict[str, str]:
    """Health check endpoint for monitoring and load balancers.

    Returns:
        dict[str, str]: Health status indicator.
    """
    return {"status": "healthy"}

health_jobs async 

health_jobs(
    monitor: JobsMonitor = Depends(get_jobs_monitor),
) -> dict[str, str]

Health check for background jobs service (load balancer use).

Simple health check endpoint for load balancers and infrastructure monitoring. Returns only status without sensitive details like queue length or error messages.

For detailed job status, use the authenticated admin endpoint: GET /api/v1/admin/jobs

Parameters:

Name Type Description Default
monitor JobsMonitor

JobsMonitor instance for querying job queue status.

 Depends(get_jobs_monitor)

Returns:

Type Description
dict[str, str]

dict[str, str]: Simple status indicator (healthy/unhealthy).
Source code in src/presentation/routers/system.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
@system_router.get("/health/jobs")
async def health_jobs(
    monitor: "JobsMonitor" = Depends(get_jobs_monitor),
) -> dict[str, str]:
    """Health check for background jobs service (load balancer use).

    Simple health check endpoint for load balancers and infrastructure monitoring.
    Returns only status without sensitive details like queue length or error messages.

    For detailed job status, use the authenticated admin endpoint:
    GET /api/v1/admin/jobs

    Args:
        monitor: JobsMonitor instance for querying job queue status.

    Returns:
        dict[str, str]: Simple status indicator (healthy/unhealthy).
    """
    result = await monitor.check_health()

    if isinstance(result, Failure) or not result.value.healthy:
        return {"status": "unhealthy"}

    return {"status": "healthy"}

get_config async 

get_config() -> JSONResponse

Configuration debug endpoint (development only).

Returns configuration information for debugging purposes. In non-development environments this endpoint is disabled.

Returns:

Name Type Description
JSONResponse JSONResponse

Configuration details (sanitized) or 403 in non-development environments.
Source code in src/presentation/routers/system.py 
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
@system_router.get("/config")
async def get_config() -> JSONResponse:
    """Configuration debug endpoint (development only).

    Returns configuration information for debugging purposes. In
    non-development environments this endpoint is disabled.

    Returns:
        JSONResponse: Configuration details (sanitized) or 403 in
            non-development environments.
    """
    if not settings.is_development:
        return JSONResponse(
            status_code=403,
            content={"detail": "Config endpoint only available in development"},
        )

    return JSONResponse(
        content={
            "environment": settings.environment.value,
            "debug": settings.debug,
            "api": {
                "name": settings.app_name,
                "version": settings.app_version,
                "base_url": settings.api_base_url,
                "v1_prefix": settings.api_v1_prefix,
            },
            "database": {
                "url": "<redacted>",  # Never expose credentials
                "echo": settings.db_echo,
            },
            "cache": {
                "url": "<redacted>",
            },
            "cors": {
                "origins": settings.cors_origins,
                "allow_credentials": settings.cors_allow_credentials,
            },
        }
    )