Enhance API documentation and health check response

- Update health check to return a simplified response
- Modify OpenAPI URL to include ROOT_PATH
- Add redirect endpoint for scalar documentation
- Update docker-compose to mount models directory

Author: laviprog

docker-compose.yml

@@ -13,6 +13,8 @@ services:
       - speech-transcription-postgres
     networks:
       - speech-transcription-network
+    volumes:
+      - ./models:/app/models
     #deploy:
     #  resources:
     #    reservations:

src/routes.py

@@ -1,8 +1,8 @@
-from datetime import datetime
-
-from fastapi import APIRouter
+from fastapi import APIRouter, Request
 from scalar_fastapi import get_scalar_api_reference
+from fastapi.responses import RedirectResponse
 
+from src.config import settings
 from src.schemas import HealthCheck
 
 router = APIRouter(tags=["Monitoring"])
@@ -21,12 +21,18 @@
     },
 )
 async def healthcheck() -> HealthCheck:
-    return HealthCheck(timestamp=datetime.utcnow().isoformat())
+    return HealthCheck()
 
 
 @router.get("/docs", include_in_schema=False)
 async def scalar_html():
     return get_scalar_api_reference(
-        openapi_url="/openapi.json",
-        title="Speech Transcription API",
+        openapi_url=f"{settings.ROOT_PATH}/openapi.json",
+        title="Speech recognition API",
     )
+
+
+@router.get("/docs/scalar", include_in_schema=False)
+async def redirect_to_docs(request: Request):
+    docs_url = str(request.url_for("scalar_html"))
+    return RedirectResponse(url=docs_url)

src/schemas.py

@@ -1,10 +1,12 @@
-from pydantic import BaseModel
+from datetime import datetime, timezone
+
+from pydantic import BaseModel, Field
 
 
 class BaseSchema(BaseModel):
     model_config = {"from_attributes": True}
 
 
-class HealthCheck(BaseSchema):
+class HealthCheck(BaseModel):
     status: str = "ok"
-    timestamp: str
+    timestamp: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))