feat: add description to settings

pmareke · Sep 26, 2024 · 0a38f49 · 0a38f49
1 parent f0351cc
commit 0a38f49
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/main.py b/main.py
@@ -23,7 +23,7 @@ async def lifespan(_app: FastAPI) -> AsyncGenerator:
 
 app = FastAPI(
     title=settings.project_name,
-    description="This is the documentation of the FastAPI template project.",
+    description=settings.description,
     lifespan=lifespan,
     openapi_url=settings.openapi_url,
 )

diff --git a/src/common/settings.py b/src/common/settings.py
@@ -5,6 +5,7 @@ class Settings(BaseSettings):
     openapi_url: str = "/openapi.json"
     api_v1_prefix: str = "/api/v1"
     project_name: str = "FastAPI Template"
+    description: str = "This is the documentation of the FastAPI template project."
     logger_name: str = "server"