misc: add comment to explain why no exception is thrown on api key check

This commit is contained in:
Iain Learmonth 2026-05-21 13:15:43 +01:00
parent df1bb8cdd8
commit 6688beeaad

View file

@ -8,6 +8,8 @@ from src.config import settings
def api_key(host: str = Header(), authorization: str | None = Header(None)) -> bool:
# This function deliberately does not throw an exception in the case of unauthenticated use as there are public
# endpoints that need to optionally be authenticated.
if host.lower().strip() != settings.API_DOMAIN.strip():
raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
try: