Skip to content

Commit 5f3159c

Browse files
committed
fix: Improve documentation in template env and OpenAPI
1 parent 889dcf6 commit 5f3159c

File tree

2 files changed

+8
-8
lines changed

2 files changed

+8
-8
lines changed

app/main.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
from app.router import api_router
1919

2020
DESCRIPTION = """
21-
A simple user registry backend for Secure Chain tools.
21+
A simple user registry backend for Secure Chain tools, built with FastAPI. This service provides user authentication, registration, password management, and token-based security.
2222
"""
2323

2424
@asynccontextmanager
@@ -27,17 +27,17 @@ async def lifespan(_: FastAPI):
2727
await close_session()
2828

2929
app = FastAPI(
30-
title="SecureChain User Backend",
31-
version="1.0.0",
30+
title="Secure Chain User Backend",
31+
version="1.0.2",
3232
description=DESCRIPTION,
3333
contact={
34-
"name": "SecureChain Team",
34+
"name": "Secure Chain Team",
3535
"url": "https://github.com/securechaindev",
3636
"email": "hi@securechain.dev",
3737
},
3838
license_info={
39-
"name": "License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)",
40-
"url": "https://www.gnu.org/licenses/gpl-3.0.html",
39+
"name": "License :: OSI Approved :: Apache Software License",
40+
"url": "https://www.apache.org/licenses/LICENSE-2.0",
4141
},
4242
lifespan=lifespan
4343
)

template.env

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ VULN_DB_USER='mongoSecureChain'
1313
VULN_DB_PASSWORD='mongoSecureChain'
1414

1515
# Secrets for JWT
16-
ALGORITHM = 'HS256'
16+
ALGORITHM = 'your_preferred_algorithm' # e.g., 'HS256'
1717
ACCESS_TOKEN_EXPIRE_MINUTES = 'access_token_expire_minutes'
1818
REFRESH_TOKEN_EXPIRE_DAYS = 'refresh_token_expire_days'
19-
JWT_ACCESS_SECRET_KEY = 'your_access_secret_key'
19+
JWT_ACCESS_SECRET_KEY = 'your_access_secret_key' # Need to be equal to the one in other services
2020
JWT_REFRESH_SECRET_KEY = 'your_refresh_secret_key'
2121
SECURE = 'False' # Set to True in production

0 commit comments

Comments
 (0)