fix(backend): issue with response codes on various download routes

Signed-off-by: Jordan Shatford <jordanshatford@live.com>
jordanshatford · Aug 26, 2023 · 3f390fc · 3f390fc
1 parent 3f13c5c
commit 3f390fc
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 18 deletions.
diff --git a/backend/app/dependencies.py b/backend/app/dependencies.py
@@ -48,7 +48,9 @@ def get_request_session(credentials: HTTPBearerCredentials) -> Session:
 }
 
 
-def get_request_download(video_id: str, session: DependsSession) -> YoutubeDownloadThread:  # noqa: E501
+def get_request_download(
+    video_id: str, session: DependsSession,
+) -> YoutubeDownloadThread:
     download = session.download_manager.get(video_id)
     if download is None:
         raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)

diff --git a/backend/app/routers/downloads.py b/backend/app/routers/downloads.py
@@ -10,6 +10,7 @@
 from sse_starlette.sse import EventSourceResponse
 
 from ..dependencies import depends_download_responses
+from ..dependencies import depends_session_responses
 from ..dependencies import DependsDownload
 from ..dependencies import DependsSession
 from ..models import StatusUpdate
@@ -20,7 +21,7 @@
 router = APIRouter(
     prefix='/downloads',
     tags=['downloads'],
-    responses=depends_download_responses,
+    responses=depends_session_responses,
 )
 
 
@@ -60,13 +61,14 @@ async def get_downloads_status(request: Request, session_id: str):
     return EventSourceResponse(event_source)
 
 
-@router.get('/{video_id}')
+@router.get('/{video_id}', responses=depends_download_responses)
 def get_download(download: DependsDownload) -> Video:
     return download.video
 
 
 @router.get(
     '/{video_id}/file', response_class=FileResponse, responses={
+        **depends_download_responses,
         status.HTTP_200_OK: {
             'content': {'audio/*': {'schema': {'type': 'file'}}},
         },
@@ -79,14 +81,17 @@ def get_download_file(download: DependsDownload):
         raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
 
 
-@router.get('/{video_id}/status')
+@router.get('/{video_id}/status', responses=depends_download_responses)
 def get_download_status(download: DependsDownload) -> StatusUpdate:
     return StatusUpdate(id=download.video.id, status=download.status)
 
 
-@router.delete('/{video_id}', status_code=status.HTTP_204_NO_CONTENT)
-def delete_download(video_id: str, session: DependsSession) -> None:
-    if video_id in session.download_manager:
-        session.download_manager.remove(video_id)
-    else:
-        raise HTTPException(status_code=status.HTTP_404_NOT_FOUND)
+@router.delete(
+    '/{video_id}', status_code=status.HTTP_204_NO_CONTENT,
+    responses=depends_download_responses,
+)
+def delete_download(
+    download: DependsDownload,
+    session: DependsSession,
+) -> None:
+    session.download_manager.remove(download.video.id)
diff --git a/backend/app/routers/search.py b/backend/app/routers/search.py
@@ -18,7 +18,10 @@
 
 
 @router.get('')
-def get_search(session: DependsSession, term: str, results: int = 12) -> list[Video]:  # noqa: E501
+def get_search(
+    session: DependsSession, term: str,
+    results: int = 12,
+) -> list[Video]:
     session.update_use_time()
     videos = search_youtube(term, results)
     if len(videos) == 0:

diff --git a/backend/app/utils/managers.py b/backend/app/utils/managers.py
@@ -14,7 +14,10 @@
 
 
 class AudioDownloadManager:
-    def __init__(self, output_dir: str, announcer: Callable[[str, Status], None]):  # noqa: E501
+    def __init__(
+        self, output_dir: str,
+        announcer: Callable[[str, Status], None],
+    ):
         self._announcer = announcer
         self._downloads: dict[str, YoutubeDownloadThread] = {}
         self._output_dir = output_dir

diff --git a/backend/openapi.json b/backend/openapi.json
@@ -126,9 +126,6 @@
                     },
                     "403": {
                         "description": "Forbidden"
-                    },
-                    "404": {
-                        "description": "Not Found"
                     }
                 },
                 "security": [
@@ -167,9 +164,6 @@
                     "403": {
                         "description": "Forbidden"
                     },
-                    "404": {
-                        "description": "Not Found"
-                    },
                     "422": {
                         "description": "Validation Error",
                         "content": {