Explicit parameter names, split common to own types, site_id under resource

app/routers/account/account.py

@@ -1,9 +1,11 @@
-from fastapi import HTTPException, Request, Depends, Query
-from . import models, facility_adapter
+from fastapi import Depends, HTTPException, Query, Request
+
+from ...types.http import forbidExtraQueryParams
+from ...types.models import Capability
+from ...types.scalars import StrictDateTime
 from .. import iri_router
 from ..error_handlers import DEFAULT_RESPONSES
-from ..common import forbidExtraQueryParams, StrictDateTime, Capability
-
+from . import facility_adapter, models
 
 router = iri_router.IriRouter(
     facility_adapter.FacilityAdapter,
@@ -18,8 +20,7 @@
     description="Get a list of capabilities at this facility.",
     responses=DEFAULT_RESPONSES,
     operation_id="getCapabilities",
-
-)
+    response_model_exclude_none=True)
 async def get_capabilities(
     request : Request,
     name : str = Query(default=None, min_length=1),
@@ -28,7 +29,7 @@ async def get_capabilities(
     limit : int = Query(default=100, ge=0, le=1000),
     _forbid = Depends(forbidExtraQueryParams("name", "modified_since", "offset", "limit")),
     ) -> list[Capability]:
-    return await router.adapter.get_capabilities()
+    return await router.adapter.get_capabilities(name=name, modified_since=modified_since, offset=offset, limit=limit)
 
 
 @router.get(
@@ -44,7 +45,7 @@ async def get_capability(
     modified_since: StrictDateTime = Query(default=None),
     _forbid = Depends(forbidExtraQueryParams("modified_since")),
     ) -> Capability:
-    caps = await router.adapter.get_capabilities()
+    caps = await router.adapter.get_capabilities(name=None, modified_since=modified_since, offset=0, limit=100)
     cc = next((c for c in caps if c.id == capability_id), None)
     if not cc:
         raise HTTPException(status_code=404, detail="Capability not found")
@@ -63,7 +64,7 @@ async def get_projects(
     request : Request,
     _forbid = Depends(forbidExtraQueryParams()),
     ) -> list[models.Project]:
-    user = await router.adapter.get_user(request.state.current_user_id, request.state.api_key, iri_router.get_client_ip(request))
+    user = await router.adapter.get_user(user_id=request.state.current_user_id, api_key=request.state.api_key, client_ip=iri_router.get_client_ip(request))
     if not user:
         raise HTTPException(status_code=404, detail="User not found")
     return await router.adapter.get_projects(user)
@@ -82,10 +83,10 @@ async def get_project(
     request : Request,
     _forbid = Depends(forbidExtraQueryParams()),
     ) -> models.Project:
-    user = await router.adapter.get_user(request.state.current_user_id, request.state.api_key, iri_router.get_client_ip(request))
+    user = await router.adapter.get_user(user_id=request.state.current_user_id, api_key=request.state.api_key, client_ip=iri_router.get_client_ip(request))
     if not user:
         raise HTTPException(status_code=404, detail="User not found")
-    projects = await router.adapter.get_projects(user)
+    projects = await router.adapter.get_projects(user=user)
     pp = next((p for p in projects if p.id == project_id), None)
     if not pp:
         raise HTTPException(status_code=404, detail="Project not found")
@@ -105,14 +106,14 @@ async def get_project_allocations(
     request : Request,
     _forbid = Depends(forbidExtraQueryParams()),
     ) -> list[models.ProjectAllocation]:
-    user = await router.adapter.get_user(request.state.current_user_id, request.state.api_key, iri_router.get_client_ip(request))
+    user = await router.adapter.get_user(user_id=request.state.current_user_id, api_key=request.state.api_key, client_ip=iri_router.get_client_ip(request))
     if not user:
         raise HTTPException(status_code=404, detail="User not found")
-    projects = await router.adapter.get_projects(user)
+    projects = await router.adapter.get_projects(user=user)
     project = next((p for p in projects if p.id == project_id), None)
     if not project:
         raise HTTPException(status_code=404, detail="Project not found")
-    return await router.adapter.get_project_allocations(project, user)
+    return await router.adapter.get_project_allocations(project=project, user=user)
 
 
 @router.get(
@@ -129,12 +130,12 @@ async def get_project_allocation(
     request : Request,
     _forbid = Depends(forbidExtraQueryParams()),
     ) -> models.ProjectAllocation:
-    user = await router.adapter.get_user(request.state.current_user_id, request.state.api_key, iri_router.get_client_ip(request))
+    user = await router.adapter.get_user(user_id=request.state.current_user_id, api_key=request.state.api_key, client_ip=iri_router.get_client_ip(request))
     if not user:
         raise HTTPException(status_code=404, detail="User not found")
-    projects = await router.adapter.get_projects(user)
+    projects = await router.adapter.get_projects(user=user)
     project = next((p for p in projects if p.id == project_id), None)
-    pas = await router.adapter.get_project_allocations(project, user)
+    pas = await router.adapter.get_project_allocations(project=project, user=user)
     pa = next((pa for pa in pas if pa.id == project_allocation_id), None)
     if not pa:
         raise HTTPException(status_code=404, detail="Project allocation not found")
@@ -155,18 +156,18 @@ async def get_user_allocations(
     request : Request,
     _forbid = Depends(forbidExtraQueryParams()),
     ) -> list[models.UserAllocation]:
-    user = await router.adapter.get_user(request.state.current_user_id, request.state.api_key, iri_router.get_client_ip(request))
+    user = await router.adapter.get_user(user_id=request.state.current_user_id, api_key=request.state.api_key, client_ip=iri_router.get_client_ip(request))
     if not user:
         raise HTTPException(status_code=404, detail="User not found")
-    projects = await router.adapter.get_projects(user)
+    projects = await router.adapter.get_projects(user=user)
     project = next((p for p in projects if p.id == project_id), None)
     if not project:
         raise HTTPException(status_code=404, detail="Project not found")
-    pas = await router.adapter.get_project_allocations(project, user)
+    pas = await router.adapter.get_project_allocations(project=project, user=user)
     pa = next((pa for pa in pas if pa.id == project_allocation_id), None)
     if not pa:
         raise HTTPException(status_code=404, detail="Project allocation not found")
-    return await router.adapter.get_user_allocations(user, pa)
+    return await router.adapter.get_user_allocations(user=user, project_allocation=pa)
 
 
 @router.get(
@@ -184,18 +185,18 @@ async def get_user_allocation(
     request : Request,
     _forbid = Depends(forbidExtraQueryParams()),
     ) -> models.UserAllocation:
-    user = await router.adapter.get_user(request.state.current_user_id, request.state.api_key, iri_router.get_client_ip(request))
+    user = await router.adapter.get_user(user_id=request.state.current_user_id, api_key=request.state.api_key, client_ip=iri_router.get_client_ip(request))
     if not user:
         raise HTTPException(status_code=404, detail="User not found")
-    projects = await router.adapter.get_projects(user)
+    projects = await router.adapter.get_projects(user=user)
     project = next((p for p in projects if p.id == project_id), None)
     if not project:
         raise HTTPException(status_code=404, detail="Project not found")
-    pas = await router.adapter.get_project_allocations(project, user)
+    pas = await router.adapter.get_project_allocations(project=project, user=user)
     pa = next((pa for pa in pas if pa.id == project_allocation_id), None)
     if not pa:
         raise HTTPException(status_code=404, detail="Project allocation not found")
-    uas = await router.adapter.get_user_allocations(user, pa)
+    uas = await router.adapter.get_user_allocations(user=user, project_allocation=pa)
     ua = next((ua for ua in uas if ua.id == user_allocation_id), None)
     if not ua:
         raise HTTPException(status_code=404, detail="User allocation not found")

app/routers/account/facility_adapter.py

@@ -1,7 +1,8 @@
 from abc import abstractmethod
-from . import models as account_models
-from ..common import Capability
+
+from ...types.models import Capability
 from ..iri_router import AuthenticatedAdapter
+from . import models as account_models
 
 
 class FacilityAdapter(AuthenticatedAdapter):
@@ -14,6 +15,10 @@ class FacilityAdapter(AuthenticatedAdapter):
     @abstractmethod
     async def get_capabilities(
         self : "FacilityAdapter",
+        name : str | None = None,
+        modified_since : str | None = None,
+        offset : int = 0,
+        limit : int = 1000
         ) -> list[Capability]:
         pass
 
@@ -39,6 +44,6 @@ async def get_project_allocations(
     async def get_user_allocations(
         self : "FacilityAdapter",
         user: account_models.User,
-        project_allocation: account_models.ProjectAllocation,
+        project_allocation: account_models.ProjectAllocation
         ) -> list[account_models.UserAllocation]:
         pass

app/routers/account/models.py

@@ -1,6 +1,8 @@
-from pydantic import computed_field, Field
+from pydantic import Field, computed_field
+
 from ... import config
-from ..common import IRIBaseModel, AllocationUnit
+from ...types.base import IRIBaseModel
+from ...types.scalars import AllocationUnit
 
 
 class User(IRIBaseModel):