utils

Utilities APIRouter

check_model(model_instance, model_class, id)

Handle a missing model

Parameters:

Name	Type	Description	Default
model_instance	Optional[DatabaseType]	The model instance to check	required
model_class	Type[DatabaseType]	The model class to check	required
id	int	The ID of the model instance	required

Returns:

Type	Description
DatabaseType	The model instance (if it exists)

Raises:

Type	Description
HTTPException	If the model instance is None or has been deleted

Source code in zoo/api/utils.py

def check_model(
    model_instance: Optional[DatabaseTypeDeletedAt],
    model_class: Type[DatabaseTypeDeletedAt],
    id: int,  # noqa: A002
) -> DatabaseTypeDeletedAt:
    """
    Handle a missing model

    Parameters
    ----------
    model_instance : Optional[DatabaseType]
        The model instance to check
    model_class : Type[DatabaseType]
        The model class to check
    id : int
        The ID of the model instance

    Returns
    -------
    DatabaseType
        The model instance (if it exists)

    Raises
    ------
    HTTPException
        If the model instance is None or has been deleted
    """
    error_msg = f"Error: `{model_class.__name__}` data not found or deleted - ID: {id}"
    if model_instance is None or model_instance.deleted_at is not None:
        raise HTTPException(status_code=404, detail=error_msg)
    return model_instance

health_check()

Check the health of the application

Source code in zoo/api/utils.py

@utils_router.get("/health", response_model=Health)
def health_check() -> Health:
    """
    Check the health of the application
    """
    return Health(
        status="OK",
        code=200,
        timestamp=datetime.datetime.now(tz=datetime.timezone.utc),
    )

swagger_docs()

Custom Swagger UI HTML

Source code in zoo/api/utils.py

@utils_router.get("/docs", include_in_schema=False)
def swagger_docs() -> HTMLResponse:
    """
    Custom Swagger UI HTML
    """
    return get_swagger_ui_html(
        openapi_url="/openapi.json",
        title=f"{__application__} - Swagger UI",
        swagger_favicon_url=__favicon__,
    )