"""
Infrastructure endpoints, such as health checks. Generally not to be
called by the frontend, but rather by monitoring systems.
"""

from fastapi import APIRouter

from . import models

router = APIRouter()


@router.get(
    "/hello",
    response_model=models.responses.HelloResponse,
    responses={
        200: {
            "model": models.responses.HelloResponse,
            "description": "Service is running and reachable.",
        }
    },
    summary="Check if the service is running",
    description="This endpoint is used to check if the service is "
    "running and reachable (health check).",
)
async def hello():
    return models.responses.HelloResponse(status="ok")