Fix exception with endpoints returning HTTP status code 204. Fixes #1891

gns3server/api/routes/controller/computes.py

@@ -18,7 +18,7 @@
 API routes for computes.
 """
 
-from fastapi import APIRouter, Depends, status
+from fastapi import APIRouter, Depends, Response, status
 from typing import List, Union
 from uuid import UUID
 
@@ -93,12 +93,13 @@ async def update_compute(
 @router.delete("/{compute_id}", status_code=status.HTTP_204_NO_CONTENT)
 async def delete_compute(
     compute_id: Union[str, UUID], computes_repo: ComputesRepository = Depends(get_repository(ComputesRepository))
-) -> None:
+) -> Response:
     """
     Delete a compute from the controller.
     """
 
     await ComputesService(computes_repo).delete_compute(compute_id)
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.get("/{compute_id}/{emulator}/images")

gns3server/api/routes/controller/controller.py

@@ -18,7 +18,7 @@ import asyncio
 import signal
 import os
 
-from fastapi import APIRouter, Depends, status
+from fastapi import APIRouter, Depends, Response, status
 from fastapi.encoders import jsonable_encoder
 from typing import List
 
@@ -72,12 +72,13 @@ def check_version(version: schemas.Version) -> dict:
     dependencies=[Depends(get_current_active_user)],
     status_code=status.HTTP_204_NO_CONTENT,
 )
-async def reload() -> None:
+async def reload() -> Response:
     """
     Reload the controller
     """
 
     await Controller.instance().reload()
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.post(
@@ -86,7 +87,7 @@ async def reload() -> None:
     status_code=status.HTTP_204_NO_CONTENT,
     responses={403: {"model": schemas.ErrorMessage, "description": "Server shutdown not allowed"}},
 )
-async def shutdown() -> None:
+async def shutdown() -> Response:
     """
     Shutdown the server
     """
@@ -114,6 +115,7 @@ async def shutdown() -> None:
 
     # then shutdown the server itself
     os.kill(os.getpid(), signal.SIGTERM)
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.get(

gns3server/api/routes/controller/drawings.py

@@ -18,7 +18,7 @@
 API routes for drawings.
 """
 
-from fastapi import APIRouter, status
+from fastapi import APIRouter, Response, status
 from fastapi.encoders import jsonable_encoder
 from typing import List
 from uuid import UUID
@@ -76,10 +76,11 @@ async def update_drawing(project_id: UUID, drawing_id: UUID, drawing_data: schem
 
 
 @router.delete("/{drawing_id}", status_code=status.HTTP_204_NO_CONTENT)
-async def delete_drawing(project_id: UUID, drawing_id: UUID) -> None:
+async def delete_drawing(project_id: UUID, drawing_id: UUID) -> Response:
     """
     Delete a drawing.
     """
 
     project = await Controller.instance().get_loaded_project(str(project_id))
     await project.delete_drawing(str(drawing_id))
+    return Response(status_code=status.HTTP_204_NO_CONTENT)

gns3server/api/routes/controller/groups.py

@@ -19,7 +19,7 @@
 API routes for user groups.
 """
 
-from fastapi import APIRouter, Depends, status
+from fastapi import APIRouter, Depends, Response, status
 from uuid import UUID
 from typing import List
 
@@ -112,7 +112,7 @@ async def update_user_group(
 async def delete_user_group(
     user_group_id: UUID,
     users_repo: UsersRepository = Depends(get_repository(UsersRepository)),
-) -> None:
+) -> Response:
     """
     Delete an user group
     """
@@ -128,6 +128,8 @@ async def delete_user_group(
     if not success:
         raise ControllerNotFoundError(f"User group '{user_group_id}' could not be deleted")
 
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
+
 
 @router.get("/{user_group_id}/members", response_model=List[schemas.User])
 async def get_user_group_members(
@@ -149,7 +151,7 @@ async def add_member_to_group(
         user_group_id: UUID,
         user_id: UUID,
         users_repo: UsersRepository = Depends(get_repository(UsersRepository))
-) -> None:
+) -> Response:
     """
     Add member to an user group.
     """
@@ -162,6 +164,8 @@ async def add_member_to_group(
     if not user_group:
         raise ControllerNotFoundError(f"User group '{user_group_id}' not found")
 
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
+
 
 @router.delete(
     "/{user_group_id}/members/{user_id}",
@@ -171,7 +175,7 @@ async def remove_member_from_group(
     user_group_id: UUID,
     user_id: UUID,
     users_repo: UsersRepository = Depends(get_repository(UsersRepository)),
-) -> None:
+) -> Response:
     """
     Remove member from an user group.
     """
@@ -184,6 +188,8 @@ async def remove_member_from_group(
     if not user_group:
         raise ControllerNotFoundError(f"User group '{user_group_id}' not found")
 
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
+
 
 @router.get("/{user_group_id}/roles", response_model=List[schemas.Role])
 async def get_user_group_roles(
@@ -206,7 +212,7 @@ async def add_role_to_group(
         role_id: UUID,
         users_repo: UsersRepository = Depends(get_repository(UsersRepository)),
         rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
-) -> None:
+) -> Response:
     """
     Add role to an user group.
     """
@@ -219,6 +225,8 @@ async def add_role_to_group(
     if not user_group:
         raise ControllerNotFoundError(f"User group '{user_group_id}' not found")
 
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
+
 
 @router.delete(
     "/{user_group_id}/roles/{role_id}",
@@ -229,7 +237,7 @@ async def remove_role_from_group(
     role_id: UUID,
     users_repo: UsersRepository = Depends(get_repository(UsersRepository)),
     rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
-) -> None:
+) -> Response:
     """
     Remove role from an user group.
     """
@@ -241,3 +249,5 @@ async def remove_role_from_group(
     user_group = await users_repo.remove_role_from_user_group(user_group_id, role)
     if not user_group:
         raise ControllerNotFoundError(f"User group '{user_group_id}' not found")
+
+    return Response(status_code=status.HTTP_204_NO_CONTENT)

gns3server/api/routes/controller/links.py

@@ -21,7 +21,7 @@ API routes for links.
 import multidict
 import aiohttp
 
-from fastapi import APIRouter, Depends, Request, status
+from fastapi import APIRouter, Depends, Request, Response, status
 from fastapi.responses import StreamingResponse
 from fastapi.encoders import jsonable_encoder
 from typing import List
@@ -136,13 +136,14 @@ async def update_link(link_data: schemas.LinkUpdate, link: Link = Depends(dep_li
 
 
 @router.delete("/{link_id}", status_code=status.HTTP_204_NO_CONTENT)
-async def delete_link(project_id: UUID, link: Link = Depends(dep_link)) -> None:
+async def delete_link(project_id: UUID, link: Link = Depends(dep_link)) -> Response:
     """
     Delete a link.
     """
 
     project = await Controller.instance().get_loaded_project(str(project_id))
     await project.delete_link(link.id)
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.post("/{link_id}/reset", response_model=schemas.Link)
@@ -169,12 +170,13 @@ async def start_capture(capture_data: dict, link: Link = Depends(dep_link)) -> s
 
 
 @router.post("/{link_id}/capture/stop", status_code=status.HTTP_204_NO_CONTENT)
-async def stop_capture(link: Link = Depends(dep_link)) -> None:
+async def stop_capture(link: Link = Depends(dep_link)) -> Response:
     """
     Stop packet capture on the link.
     """
 
     await link.stop_capture()
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.get("/{link_id}/capture/stream")

gns3server/api/routes/controller/nodes.py

@@ -130,40 +130,44 @@ async def get_nodes(project: Project = Depends(dep_project)) -> List[schemas.Nod
 
 
 @router.post("/start", status_code=status.HTTP_204_NO_CONTENT)
-async def start_all_nodes(project: Project = Depends(dep_project)) -> None:
+async def start_all_nodes(project: Project = Depends(dep_project)) -> Response:
     """
     Start all nodes belonging to a given project.
     """
 
     await project.start_all()
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.post("/stop", status_code=status.HTTP_204_NO_CONTENT)
-async def stop_all_nodes(project: Project = Depends(dep_project)) -> None:
+async def stop_all_nodes(project: Project = Depends(dep_project)) -> Response:
     """
     Stop all nodes belonging to a given project.
     """
 
     await project.stop_all()
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.post("/suspend", status_code=status.HTTP_204_NO_CONTENT)
-async def suspend_all_nodes(project: Project = Depends(dep_project)) -> None:
+async def suspend_all_nodes(project: Project = Depends(dep_project)) -> Response:
     """
     Suspend all nodes belonging to a given project.
     """
 
     await project.suspend_all()
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.post("/reload", status_code=status.HTTP_204_NO_CONTENT)
-async def reload_all_nodes(project: Project = Depends(dep_project)) -> None:
+async def reload_all_nodes(project: Project = Depends(dep_project)) -> Response:
     """
     Reload all nodes belonging to a given project.
     """
 
     await project.stop_all()
     await project.start_all()
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.get("/{node_id}", response_model=schemas.Node)
@@ -197,12 +201,13 @@ async def update_node(node_data: schemas.NodeUpdate, node: Node = Depends(dep_no
     status_code=status.HTTP_204_NO_CONTENT,
     responses={**responses, 409: {"model": schemas.ErrorMessage, "description": "Cannot delete node"}},
 )
-async def delete_node(node_id: UUID, project: Project = Depends(dep_project)) -> None:
+async def delete_node(node_id: UUID, project: Project = Depends(dep_project)) -> Response:
     """
     Delete a node from a project.
     """
 
     await project.delete_node(str(node_id))
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.post("/{node_id}/duplicate", response_model=schemas.Node, status_code=status.HTTP_201_CREATED)
@@ -216,39 +221,43 @@ async def duplicate_node(duplicate_data: schemas.NodeDuplicate, node: Node = Dep
 
 
 @router.post("/{node_id}/start", status_code=status.HTTP_204_NO_CONTENT)
-async def start_node(start_data: dict, node: Node = Depends(dep_node)) -> None:
+async def start_node(start_data: dict, node: Node = Depends(dep_node)) -> Response:
     """
     Start a node.
     """
 
     await node.start(data=start_data)
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.post("/{node_id}/stop", status_code=status.HTTP_204_NO_CONTENT)
-async def stop_node(node: Node = Depends(dep_node)) -> None:
+async def stop_node(node: Node = Depends(dep_node)) -> Response:
     """
     Stop a node.
     """
 
     await node.stop()
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.post("/{node_id}/suspend", status_code=status.HTTP_204_NO_CONTENT)
-async def suspend_node(node: Node = Depends(dep_node)) -> None:
+async def suspend_node(node: Node = Depends(dep_node)) -> Response:
     """
     Suspend a node.
     """
 
     await node.suspend()
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.post("/{node_id}/reload", status_code=status.HTTP_204_NO_CONTENT)
-async def reload_node(node: Node = Depends(dep_node)) -> None:
+async def reload_node(node: Node = Depends(dep_node)) -> Response:
     """
     Reload a node.
     """
 
     await node.reload()
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.get("/{node_id}/links", response_model=List[schemas.Link], response_model_exclude_unset=True)
@@ -282,11 +291,13 @@ async def idlepc_proposals(node: Node = Depends(dep_node)) -> List[str]:
 
 
 @router.post("/{node_id}/resize_disk", status_code=status.HTTP_204_NO_CONTENT)
-async def resize_disk(resize_data: dict, node: Node = Depends(dep_node)) -> None:
+async def resize_disk(resize_data: dict, node: Node = Depends(dep_node)) -> Response:
     """
     Resize a disk image.
     """
+
     await node.post("/resize_disk", **resize_data)
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.get("/{node_id}/files/{file_path:path}")
@@ -377,15 +388,17 @@ async def ws_console(websocket: WebSocket, node: Node = Depends(dep_node)) -> No
 
 
 @router.post("/console/reset", status_code=status.HTTP_204_NO_CONTENT)
-async def reset_console_all_nodes(project: Project = Depends(dep_project)) -> None:
+async def reset_console_all_nodes(project: Project = Depends(dep_project)) -> Response:
     """
     Reset console for all nodes belonging to the project.
     """
 
     await project.reset_console_all()
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.post("/{node_id}/console/reset", status_code=status.HTTP_204_NO_CONTENT)
-async def console_reset(node: Node = Depends(dep_node)) -> None:
+async def console_reset(node: Node = Depends(dep_node)) -> Response:
 
-    await node.post("/console/reset")  # , request.json)
+    await node.post("/console/reset")
+    return Response(status_code=status.HTTP_204_NO_CONTENT)

gns3server/api/routes/controller/permissions.py

@@ -19,7 +19,7 @@
 API routes for permissions.
 """
 
-from fastapi import APIRouter, Depends, status
+from fastapi import APIRouter, Depends, Response, status
 from uuid import UUID
 from typing import List
 
@@ -103,7 +103,7 @@ async def update_permission(
 async def delete_permission(
     permission_id: UUID,
     rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
-) -> None:
+) -> Response:
     """
     Delete a permission.
     """
@@ -115,3 +115,5 @@ async def delete_permission(
     success = await rbac_repo.delete_permission(permission_id)
     if not success:
         raise ControllerNotFoundError(f"Permission '{permission_id}' could not be deleted")
+
+    return Response(status_code=status.HTTP_204_NO_CONTENT)

gns3server/api/routes/controller/projects.py

@@ -30,7 +30,7 @@ import logging
 
 log = logging.getLogger()
 
-from fastapi import APIRouter, Depends, Request, Body, HTTPException, status, WebSocket, WebSocketDisconnect
+from fastapi import APIRouter, Depends, Request, Response, Body, HTTPException, status, WebSocket, WebSocketDisconnect
 from fastapi.encoders import jsonable_encoder
 from fastapi.responses import StreamingResponse, FileResponse
 from websockets.exceptions import ConnectionClosed, WebSocketException
@@ -141,7 +141,7 @@ async def update_project(
 async def delete_project(
         project: Project = Depends(dep_project),
         rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
-) -> None:
+) -> Response:
     """
     Delete a project.
     """
@@ -150,6 +150,7 @@ async def delete_project(
     await project.delete()
     controller.remove_project(project)
     await rbac_repo.delete_all_permissions_with_path(f"/projects/{project.id}")
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.get("/{project_id}/stats")
@@ -166,12 +167,13 @@ def get_project_stats(project: Project = Depends(dep_project)) -> dict:
     status_code=status.HTTP_204_NO_CONTENT,
     responses={**responses, 409: {"model": schemas.ErrorMessage, "description": "Could not close project"}},
 )
-async def close_project(project: Project = Depends(dep_project)) -> None:
+async def close_project(project: Project = Depends(dep_project)) -> Response:
     """
     Close a project.
     """
 
     await project.close()
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.post(
@@ -415,7 +417,7 @@ async def get_file(file_path: str, project: Project = Depends(dep_project)) -> F
 
 
 @router.post("/{project_id}/files/{file_path:path}", status_code=status.HTTP_204_NO_CONTENT)
-async def write_file(file_path: str, request: Request, project: Project = Depends(dep_project)) -> None:
+async def write_file(file_path: str, request: Request, project: Project = Depends(dep_project)) -> Response:
     """
     Write a file from a project.
     """
@@ -440,6 +442,8 @@ async def write_file(file_path: str, request: Request, project: Project = Depend
     except OSError as e:
         raise ControllerError(str(e))
 
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
+
 
 @router.post(
     "/{project_id}/templates/{template_id}",

gns3server/api/routes/controller/roles.py

@@ -19,7 +19,7 @@
 API routes for roles.
 """
 
-from fastapi import APIRouter, Depends, status
+from fastapi import APIRouter, Depends, Response, status
 from uuid import UUID
 from typing import List
 
@@ -105,7 +105,7 @@ async def update_role(
 async def delete_role(
     role_id: UUID,
     rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
-) -> None:
+) -> Response:
     """
     Delete a role.
     """
@@ -121,6 +121,8 @@ async def delete_role(
     if not success:
         raise ControllerNotFoundError(f"Role '{role_id}' could not be deleted")
 
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
+
 
 @router.get("/{role_id}/permissions", response_model=List[schemas.Permission])
 async def get_role_permissions(
@@ -142,7 +144,7 @@ async def add_permission_to_role(
         role_id: UUID,
         permission_id: UUID,
         rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
-) -> None:
+) -> Response:
     """
     Add a permission to a role.
     """
@@ -155,6 +157,8 @@ async def add_permission_to_role(
     if not role:
         raise ControllerNotFoundError(f"Role '{role_id}' not found")
 
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
+
 
 @router.delete(
     "/{role_id}/permissions/{permission_id}",
@@ -164,7 +168,7 @@ async def remove_permission_from_role(
     role_id: UUID,
     permission_id: UUID,
     rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
-) -> None:
+) -> Response:
     """
     Remove member from an user group.
     """
@@ -176,3 +180,5 @@ async def remove_permission_from_role(
     role = await rbac_repo.remove_permission_from_role(role_id, permission)
     if not role:
         raise ControllerNotFoundError(f"Role '{role_id}' not found")
+
+    return Response(status_code=status.HTTP_204_NO_CONTENT)

gns3server/api/routes/controller/snapshots.py

@@ -23,7 +23,7 @@ import logging
 
 log = logging.getLogger()
 
-from fastapi import APIRouter, Depends, status
+from fastapi import APIRouter, Depends, Response, status
 from typing import List
 from uuid import UUID
 
@@ -69,12 +69,13 @@ def get_snapshots(project: Project = Depends(dep_project)) -> List[schemas.Snaps
 
 
 @router.delete("/{snapshot_id}", status_code=status.HTTP_204_NO_CONTENT)
-async def delete_snapshot(snapshot_id: UUID, project: Project = Depends(dep_project)) -> None:
+async def delete_snapshot(snapshot_id: UUID, project: Project = Depends(dep_project)) -> Response:
     """
     Delete a snapshot.
     """
 
     await project.delete_snapshot(str(snapshot_id))
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.post("/{snapshot_id}/restore", status_code=status.HTTP_201_CREATED, response_model=schemas.Project)

gns3server/api/routes/controller/symbols.py

@@ -21,7 +21,7 @@ API routes for symbols.
 
 import os
 
-from fastapi import APIRouter, Request, Depends, status
+from fastapi import APIRouter, Request, Depends, Response, status
 from fastapi.responses import FileResponse
 from typing import List
 
@@ -95,7 +95,7 @@ def get_default_symbols() -> dict:
     dependencies=[Depends(get_current_active_user)],
     status_code=status.HTTP_204_NO_CONTENT
 )
-async def upload_symbol(symbol_id: str, request: Request) -> None:
+async def upload_symbol(symbol_id: str, request: Request) -> Response:
     """
     Upload a symbol file.
     """
@@ -111,3 +111,5 @@ async def upload_symbol(symbol_id: str, request: Request) -> None:
 
     # Reset the symbol list
     controller.symbols.list()
+
+    return Response(status_code=status.HTTP_204_NO_CONTENT)

gns3server/api/routes/controller/templates.py

@@ -25,7 +25,7 @@ import logging
 
 log = logging.getLogger(__name__)
 
-from fastapi import APIRouter, Request, Response, HTTPException, Depends, status
+from fastapi import APIRouter, Request, Response, HTTPException, Depends, Response, status
 from typing import List
 from uuid import UUID
 
@@ -102,13 +102,14 @@ async def delete_template(
         template_id: UUID,
         templates_repo: TemplatesRepository = Depends(get_repository(TemplatesRepository)),
         rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
-) -> None:
+) -> Response:
     """
     Delete a template.
     """
 
     await TemplatesService(templates_repo).delete_template(template_id)
     await rbac_repo.delete_all_permissions_with_path(f"/templates/{template_id}")
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
 
 
 @router.get("/templates", response_model=List[schemas.Template], response_model_exclude_unset=True)

gns3server/api/routes/controller/users.py

@@ -19,7 +19,7 @@
 API routes for users.
 """
 
-from fastapi import APIRouter, Depends, HTTPException, status
+from fastapi import APIRouter, Depends, HTTPException, Response, status
 from fastapi.security import OAuth2PasswordRequestForm
 from uuid import UUID
 from typing import List
@@ -193,7 +193,7 @@ async def update_user(
 async def delete_user(
     user_id: UUID,
     users_repo: UsersRepository = Depends(get_repository(UsersRepository)),
-) -> None:
+) -> Response:
     """
     Delete an user.
     """
@@ -209,6 +209,8 @@ async def delete_user(
     if not success:
         raise ControllerNotFoundError(f"User '{user_id}' could not be deleted")
 
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
+
 
 @router.get(
     "/{user_id}/groups",
@@ -251,7 +253,7 @@ async def add_permission_to_user(
         user_id: UUID,
         permission_id: UUID,
         rbac_repo: RbacRepository = Depends(get_repository(RbacRepository))
-) -> None:
+) -> Response:
     """
     Add a permission to an user.
     """
@@ -264,6 +266,8 @@ async def add_permission_to_user(
     if not user:
         raise ControllerNotFoundError(f"User '{user_id}' not found")
 
+    return Response(status_code=status.HTTP_204_NO_CONTENT)
+
 
 @router.delete(
     "/{user_id}/permissions/{permission_id}",
@@ -274,7 +278,7 @@ async def remove_permission_from_user(
     user_id: UUID,
     permission_id: UUID,
     rbac_repo: RbacRepository = Depends(get_repository(RbacRepository)),
-) -> None:
+) -> Response:
     """
     Remove permission from an user.
     """
@@ -286,3 +290,5 @@ async def remove_permission_from_user(
     user = await rbac_repo.remove_permission_from_user(user_id, permission)
     if not user:
         raise ControllerNotFoundError(f"User '{user_id}' not found")
+
+    return Response(status_code=status.HTTP_204_NO_CONTENT)