Change to use fastapi status codes rather than ints

src/nsls2api/api/v1/beamline_api.py

@@ -1,24 +1,22 @@
 import fastapi
 from fastapi import HTTPException, Depends, Request
 from fastapi.security.api_key import APIKey
+
 from nsls2api.api.models.proposal_model import (
     ProposalDirectoriesList,
 )
-
 from nsls2api.infrastructure.logging import logger
 from nsls2api.infrastructure.security import (
     get_current_user,
     validate_admin_role,
 )
-
 from nsls2api.models.beamlines import (
     Beamline,
     BeamlineService,
     Detector,
     DetectorList,
     DirectoryList,
 )
-
 from nsls2api.services import beamline_service
 
 router = fastapi.APIRouter()
@@ -29,7 +27,7 @@ async def details(name: str):
     beamline = await beamline_service.beamline_by_name(name)
     if beamline is None:
         raise HTTPException(
-            status_code=451, detail=f"Beamline named {name} could not be found"
+            status_code=fastapi.status.HTTP_404_NOT_FOUND, detail=f"Beamline '{name}' does not exist"
         )
     return beamline
 
@@ -39,19 +37,19 @@ async def get_beamline_accounts(name: str, api_key: APIKey = Depends(get_current
     service_accounts = await beamline_service.service_accounts(name)
     if service_accounts is None:
         raise HTTPException(
-            status_code=404, detail=f"Beamline named {name} could not be found"
+            status_code=fastapi.status.HTTP_404_NOT_FOUND, detail=f"Beamline '{name}' does not exist"
         )
     return service_accounts
 
 
 @router.get("/beamline/{name}/slack-channel-managers")
 async def get_beamline_slack_channel_managers(
-    name: str, api_key: APIKey = Depends(get_current_user)
+        name: str, api_key: APIKey = Depends(get_current_user)
 ):
     slack_channel_managers = await beamline_service.slack_channel_managers(name)
     if slack_channel_managers is None:
         raise HTTPException(
-            status_code=404, detail=f"Beamline named {name} could not be found"
+            status_code=fastapi.status.HTTP_404_NOT_FOUND, detail=f"Beamline named {name} could not be found"
         )
     return slack_channel_managers
 
@@ -63,7 +61,7 @@ async def get_beamline_detectors(name: str) -> DetectorList:
     detectors = await beamline_service.detectors(name)
     if detectors is None:
         raise HTTPException(
-            status_code=404,
+            status_code=fastapi.status.HTTP_404_NOT_FOUND,
             detail=f"No detectors for the {name} beamline could not be found.",
         )
 
@@ -84,19 +82,19 @@ async def get_beamline_detectors(name: str) -> DetectorList:
     dependencies=[Depends(validate_admin_role)],
 )
 async def add_or_delete_detector(
-    request: Request, name: str, detector_name: str, detector: Detector | None = None
+        request: Request, name: str, detector_name: str, detector: Detector | None = None
 ):
     if request.method == "PUT":
         logger.info(f"Adding detector {detector_name} to beamline {name}")
 
         if not detector:
             raise HTTPException(
-                status_code=422,
+                status_code=fastapi.status.HTTP_422_UNPROCESSABLE_ENTITY,
                 detail=f"No detector information supplied in request body.",
             )
         if detector_name != detector.name:
             raise HTTPException(
-                status_code=400,
+                status_code=fastapi.status.HTTP_400_BAD_REQUEST,
                 detail=f"Detector name in path '{detector_name}' does not match name in body '{detector.name}'.",
             )
 
@@ -111,7 +109,7 @@ async def add_or_delete_detector(
 
         if new_detector is None:
             raise HTTPException(
-                status_code=409,
+                status_code=fastapi.status.HTTP_409_CONFLICT,
                 detail=f"Detector already exists in beamline {name} with either name '{detector.name}' or directory name '{detector.directory_name}'",
             )
 
@@ -126,7 +124,7 @@ async def add_or_delete_detector(
 
         if deleted_detector is None:
             raise HTTPException(
-                status_code=404,
+                status_code=fastapi.status.HTTP_404_NOT_FOUND,
                 detail=f"Detector {detector_name} was not found for beamline {name}",
             )
 
@@ -140,19 +138,6 @@ async def add_or_delete_detector(
     response_model=ProposalDirectoriesList,
     deprecated=True,
 )
-async def get_beamline_proposal_directory_skeleton(name: str):
-    directory_skeleton = await beamline_service.directory_skeleton(name)
-    if directory_skeleton is None:
-        raise HTTPException(
-            status_code=404,
-            detail=f"No proposal directory skeleton for the {name} beamline could be generated.",
-        )
-    response_model = ProposalDirectoriesList(
-        directory_count=len(directory_skeleton), directories=directory_skeleton
-    )
-    return response_model
-
-
 @router.get(
     "/beamline/{name}/directory-skeleton",
     response_model=DirectoryList,
@@ -161,7 +146,7 @@ async def get_beamline_directory_skeleton(name: str):
     directory_skeleton = await beamline_service.directory_skeleton(name)
     if directory_skeleton is None:
         raise HTTPException(
-            status_code=404,
+            status_code=fastapi.status.HTTP_404_NOT_FOUND,
             detail=f"No proposal directory skeleton for the {name} beamline could be generated.",
         )
     response_model = ProposalDirectoriesList(
@@ -181,7 +166,7 @@ async def get_beamline_workflow_username(name: str):
     workflow_user = await beamline_service.workflow_username(name)
     if workflow_user is None:
         raise HTTPException(
-            status_code=404,
+            status_code=fastapi.status.HTTP_404_NOT_FOUND,
             detail=f"No workflow user has been defined for the {name} beamline",
         )
     return workflow_user
@@ -194,7 +179,7 @@ async def get_beamline_ioc_username(name: str):
     ioc_user = await beamline_service.ioc_username(name)
     if ioc_user is None:
         raise HTTPException(
-            status_code=404,
+            status_code=fastapi.status.HTTP_404_NOT_FOUND,
             detail=f"No IOC user has been defined for the {name} beamline",
         )
     return ioc_user
@@ -207,7 +192,7 @@ async def get_beamline_bluesky_username(name: str):
     bluesky_user = await beamline_service.bluesky_username(name)
     if bluesky_user is None:
         raise HTTPException(
-            status_code=404,
+            status_code=fastapi.status.HTTP_404_NOT_FOUND,
             detail=f"No bluesky user has been defined for the {name} beamline",
         )
     return bluesky_user
@@ -222,7 +207,7 @@ async def get_beamline_epics_services_username(name: str):
     epics_user = await beamline_service.epics_services_username(name)
     if epics_user is None:
         raise HTTPException(
-            status_code=404,
+            status_code=fastapi.status.HTTP_404_NOT_FOUND,
             detail=f"No EPICS services user has been defined for the {name} beamline",
         )
     return epics_user
@@ -235,7 +220,7 @@ async def get_beamline_operator_username(name: str):
     operator_user = await beamline_service.operator_username(name)
     if operator_user is None:
         raise HTTPException(
-            status_code=404,
+            status_code=fastapi.status.HTTP_404_NOT_FOUND,
             detail=f"No operator user has been defined for the {name} beamline",
         )
     return operator_user
@@ -250,7 +235,7 @@ async def get_beamline_services(name: str):
     beamline_services = await beamline_service.all_services(name)
     if beamline_services is None:
         raise HTTPException(
-            status_code=404, detail=f"Beamline named {name} could not be found"
+            status_code=fastapi.status.HTTP_404_NOT_FOUND, detail=f"Beamline named {name} could not be found"
         )
     return beamline_services
 
@@ -275,7 +260,7 @@ async def add_beamline_service(name: str, service: BeamlineService):
 
     if new_service is None:
         raise HTTPException(
-            status_code=404,
+            status_code=fastapi.status.HTTP_404_NOT_FOUND,
             detail=f"Service {service.name} already exists in beamline {name}",
         )