Checkpoint Commit

Signed-off-by: Arpan Mahanty <[email protected]>

jukebox/main.py

@@ -40,8 +40,8 @@ async def event_shutdown():
 public_router = APIRouter()
 
 
-@public_router.get("/healthcheck")
-async def healthcheck() -> dict:
+@public_router.get("/health-check")
+async def health_check() -> dict:
     return {"status": "ok"}
 
 
@@ -51,12 +51,14 @@ async def private() -> dict:
 
 
 # Include API routers
-app.include_router(
+app.include_router(  # For public router
     private_router, prefix=API_PREFIX,
     dependencies=[Depends(has_access)],
     responses={
         401: {"description": "Invalid or expired token"},  # HTTP_401_UNAUTHORIZED
         403: {"description": "User does not have permission to access this resource"}  # HTTP_403_FORBIDDEN
     },
 )
-app.include_router(public_router, prefix=API_PREFIX)
+app.include_router(  # For private router
+    public_router, prefix=API_PREFIX,
+)

jukebox/security.py

@@ -43,6 +43,6 @@ def generate_password_hash(secret: str) -> str:
     return pwd_context.hash(secret)
 
 
-def validate_password(secret: str, hash: str) -> bool:
+def validate_password(secret: str, hashed_secret: str) -> bool:
     """Validates the password hash"""
-    return pwd_context.verify(secret, hash)
+    return pwd_context.verify(secret, hashed_secret)

migrations/README.md

@@ -0,0 +1,4 @@
+# Migrations Directory
+
+The migrations directory contains a series of migration scripts. Each migration script is a Python (.py) or 
+SQL file (.sql).