docs: Add API route names

Signed-off-by: Phoevos Kalemkeris <[email protected]>

Author: phoevos

cogstack_model_gateway/gateway/routers/models.py

@@ -100,7 +100,12 @@
 router = APIRouter()
 
 
-@router.get("/models/", response_model=list[dict], tags=["models"])
+@router.get(
+    "/models/",
+    response_model=list[dict],
+    tags=["models"],
+    name="List running CogStack Model Serve instances with metadata from the tracking server",
+)
 async def get_models(
     config: Annotated[Config, Depends(get_config)],
     verbose: Annotated[
@@ -120,7 +125,12 @@ async def get_models(
     return models
 
 
-@router.get("/models/{model_name}/info", response_model=dict, tags=["models"])
+@router.get(
+    "/models/{model_name}/info",
+    response_model=dict,
+    tags=["models"],
+    name="Get information about a running CogStack Model Serve instance",
+)
 async def get_model_info(model_name: str):
     """Get information about a running model server through its `/info` API."""
     # FIXME: Enable SSL verification when certificates are properly set up
@@ -139,7 +149,12 @@ async def get_model_info(model_name: str):
     return response.json()
 
 
-@router.post("/models/{model_name}", response_model=dict, tags=["models"])
+@router.post(
+    "/models/{model_name}",
+    response_model=dict,
+    tags=["models"],
+    name="Deploy a CogStack Model Serve instance with a given model URI or tracking ID",
+)
 async def deploy_model(
     config: Annotated[Config, Depends(get_config)],
     model_name: Annotated[str, Depends(validate_model_name)],
@@ -215,7 +230,12 @@ async def deploy_model(
     }
 
 
-@router.post("/models/{model_name}/tasks/{task}", response_model=dict, tags=["models"])
+@router.post(
+    "/models/{model_name}/tasks/{task}",
+    response_model=dict,
+    tags=["models"],
+    name="Schedule a task for execution on a running CogStack Model Serve instance",
+)
 async def execute_task(
     model_name: str,
     task: str,

cogstack_model_gateway/gateway/routers/tasks.py

@@ -11,14 +11,22 @@
 router = APIRouter()
 
 
-@router.get("/tasks/", tags=["tasks"])
+@router.get(
+    "/tasks/",
+    tags=["tasks"],
+    name="List all tasks created through the CogStack Model Gateway",
+)
 async def get_tasks():
     """List all tasks (not implemented)."""
     # FIXME: Implement authn/authz
     raise HTTPException(status_code=403, detail="Only admins can list tasks")
 
 
-@router.get("/tasks/{task_uuid}", tags=["tasks"])
+@router.get(
+    "/tasks/{task_uuid}",
+    tags=["tasks"],
+    name="Get a task created through the CogStack Model Gateway by its UUID",
+)
 async def get_task_by_uuid(
     task_uuid: str,
     config: Annotated[Config, Depends(get_config)],