Add a health check endpoint

Update shell context for GH workflow
Add more todo(s)

.github/workflows/python-publish.yaml

@@ -25,6 +25,7 @@ jobs:
             echo "::notice title=DryRun::Setting dry run to false for '${{ github.event_name }}' event"
             echo "dry_run=false" >> $GITHUB_ENV
           fi
+        shell: bash
       - uses: thevickypedia/pypi-publisher@v3
         env:
           token: ${{ secrets.PYPI_TOKEN }}

pyninja/exceptions.py

@@ -1,6 +1,7 @@
 from fastapi.exceptions import HTTPException
 
 
+# todo: move this out of "exceptions"
 class APIResponse(HTTPException):
     """Custom ``HTTPException`` from ``FastAPI`` to wrap an API response.
 

pyninja/models.py

@@ -136,6 +136,7 @@ def get_service_manager() -> ServiceManager:
     except KeyError:
         # This shouldn't happen programmatically, but just in case
         # https://docs.pydantic.dev/latest/errors/validation_errors/#model_type
+        # todo: Create an overrided object under exceptions.py
         raise ValidationError.from_exception_data(
             title="PyNinja",
             line_errors=[

pyninja/routers.py

@@ -234,6 +234,16 @@ async def docs() -> RedirectResponse:
     return RedirectResponse("/docs")
 
 
+async def health() -> exceptions.APIResponse:
+    """Health check for PyNinja.
+
+    Returns:
+        APIResponse:
+        Returns a health check response with status code 200.
+    """
+    raise exceptions.APIResponse(status_code=HTTPStatus.OK, detail=HTTPStatus.OK.phrase)
+
+
 def get_all_routes() -> List[APIRoute]:
     """Get all the routes to be added for the API server.
 
@@ -247,6 +257,7 @@ def get_all_routes() -> List[APIRoute]:
     ]
     routes = [
         APIRoute(path="/", endpoint=docs, methods=["GET"], include_in_schema=False),
+        APIRoute(path="/health", endpoint=health, methods=["GET"], include_in_schema=False),
         APIRoute(
             path="/service-status",
             endpoint=service_status,