Merge pull request #197 from sjulian4/paginating-locked

Paginating the gathering locked proposals endpoint

Author: danielballan

src/nsls2api/api/models/proposal_model.py

@@ -38,6 +38,8 @@ class CommissioningProposalsList(pydantic.BaseModel):
 class LockedProposalsList(pydantic.BaseModel):
     count: int
     locked_proposals: list[Proposal]
+    page_size: int | None = None
+    page: int | None = None
 
 
 class CycleProposalList(pydantic.BaseModel):

src/nsls2api/api/v1/admin_api.py

@@ -257,6 +257,8 @@ async def gather_locked_proposals(
     facility: str,
     beamline: Annotated[list[str], Query()] = [],
     cycle: Annotated[list[str], Query()] = [],
+    page_size: int = Query(10, ge=1, le=200),
+    page: int = Query(1, ge=1),
 ):
     for beamline_name in beamline:
         beamline_info = await beamline_service.beamline_by_name(beamline_name)
@@ -274,7 +276,7 @@ async def gather_locked_proposals(
                 detail=f"Cycle {cycle_name} not found",
             )
     locked_proposals = await proposal_service.get_locked_proposals(
-        cycles=cycle, beamlines=beamline
+        cycles=cycle, beamlines=beamline, page=page, page_size=page_size
     )
     locked_proposals_list = locked_proposals.locked_proposals
     if locked_proposals_list is None:

src/nsls2api/api/v1/proposal_api.py

@@ -103,8 +103,8 @@ async def get_proposals(
     beamline: Annotated[list[str], Query()] = [],
     cycle: Annotated[list[str], Query()] = [],
     facility: Annotated[list[FacilityName], Query()] = [FacilityName.nsls2],
-    page_size: int = 10,
-    page: int = 1,
+    page_size: int = Query(10, ge=1, le=200),
+    page: int = Query(1, ge=1),
     include_directories: bool = False,
 ):
     proposal_list = await proposal_service.fetch_proposals(

src/nsls2api/services/proposal_service.py

@@ -31,7 +31,10 @@
 
 
 async def get_locked_proposals(
-    cycles: list[str], beamlines: list[str]
+    cycles: list[str],
+    beamlines: list[str],
+    page_size: int = 10,
+    page: int = 1,
 ) -> LockedProposalsList:
     locked_proposals = None
     uppercase_beamline = []
@@ -59,10 +62,17 @@ async def get_locked_proposals(
     else:
         query = Proposal.locked == True
 
-    locked_proposals = await Proposal.find_many(query).to_list()
+    locked_proposals = (
+        await Proposal.find_many(query)
+        .limit(page_size)
+        .skip(page_size * (page - 1))
+        .to_list()
+    )
     locked_model = LockedProposalsList(
         count=len(locked_proposals),
         locked_proposals=locked_proposals,
+        page_size=page_size,
+        page=page,
     )
 
     return locked_model