Fix broken OpenAPI documentation (#37)

UCMercedACM · Jan 25, 2025 · 863d914 · 863d914
1 parent d210a62
commit 863d914
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 26 deletions.
diff --git a/server/routes/events.py b/server/routes/events.py
@@ -110,7 +110,7 @@ async def edit_event(
     request: RouteRequest,
     id: uuid.UUID,
     req: Union[ModifiedEvent, ModifiedEventWithDatetime],
-    session: SessionContainer = Depends(verify_session),
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ) -> EventsWithID:
     """Updates the specified event"""
     query = """
@@ -159,7 +159,7 @@ class DeleteResponse(BaseModel, frozen=True):
 async def delete_event(
     request: RouteRequest,
     id: uuid.UUID,
-    session: SessionContainer = Depends(verify_session),
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ) -> DeleteResponse:
     """Deletes the specified event"""
     query = """
@@ -179,7 +179,7 @@ async def delete_event(
 async def create_events(
     request: RouteRequest,
     req: EventsWithCreatorID,
-    session: SessionContainer = Depends(verify_session),
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ) -> EventsWithAllID:
     """Creates a new event given the provided data"""
     query = """
@@ -197,5 +197,6 @@ async def create_events(
 # Depends on auth
 @router.post("/events/join")
 async def join_event(
-    request: RouteRequest, session: SessionContainer = Depends(verify_session)
+    request: RouteRequest,
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ): ...
diff --git a/server/routes/projects.py b/server/routes/projects.py
@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 import datetime
 import uuid
 from typing import Annotated, Literal, Optional
@@ -162,7 +160,7 @@ async def edit_project(
     request: RouteRequest,
     id: uuid.UUID,
     req: ModifiedProject,
-    session: SessionContainer = Depends(verify_session),
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ):
     """Updates the specified project"""
 
@@ -209,7 +207,7 @@ async def edit_project(
 async def delete_project(
     request: RouteRequest,
     id: uuid.UUID,
-    session: SessionContainer = Depends(verify_session),
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ):
     """Deletes the specified project"""
     query = """
@@ -249,7 +247,7 @@ class CreateProject(BaseModel):
 async def create_project(
     request: RouteRequest,
     req: CreateProject,
-    session: SessionContainer = Depends(verify_session),
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ) -> PartialProjects:
     """Creates a new project given the provided data"""
     query = """
@@ -306,7 +304,7 @@ class JoinResponse(BaseModel):
 async def join_project(
     request: RouteRequest,
     id: uuid.UUID,
-    session: SessionContainer = Depends(verify_session),
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ) -> JoinResponse:
     # The member is authenticated already, aka meaning that there is an existing member in our database
     query = """
@@ -353,7 +351,7 @@ async def bulk_join_project(
     request: RouteRequest,
     id: uuid.UUID,
     req: list[BulkJoinMember],
-    session: SessionContainer = Depends(verify_session),
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ) -> JoinResponse:
     if len(req) > 10:
         raise BadRequestException("Must be less than 10 members")
@@ -393,7 +391,7 @@ async def bulk_join_project(
 async def leave_project(
     request: RouteRequest,
     id: uuid.UUID,
-    session: SessionContainer = Depends(verify_session),
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ) -> DeleteResponse:
     query = """
     DELETE FROM project_members
@@ -428,7 +426,7 @@ async def modify_member(
     request: RouteRequest,
     id: uuid.UUID,
     req: UpgradeMemberRole,
-    session: SessionContainer = Depends(verify_session),
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ):
     """Undocumented route to just upgrade/demote member role in projects"""
     query = """
@@ -450,7 +448,8 @@ async def modify_member(
 @router.get("/projects/me", responses={200: {"model": PartialProjects}})
 @router.limiter.limit("15/minute")
 async def get_my_projects(
-    request: RouteRequest, session: SessionContainer = Depends(verify_session)
+    request: RouteRequest,
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ) -> list[PartialProjects]:
     """Get all projects associated with the authenticated user"""
     query = """

diff --git a/server/routes/tags.py b/server/routes/tags.py
@@ -1,5 +1,3 @@
-from __future__ import annotations
-
 from typing import Annotated, Optional
 
 from fastapi import Depends, Query
@@ -23,10 +21,6 @@ class Tags(BaseModel):
     description: str
 
 
-class PartialTags(BaseModel):
-    title: str
-
-
 @router.get("/tags")
 async def get_tags(
     request: RouteRequest,
@@ -104,7 +98,7 @@ async def edit_tag(request: RouteRequest, id: int, req: ModifiedTag) -> Tags:
 async def delete_tag(
     request: RouteRequest,
     id: int,
-    session: SessionContainer = Depends(verify_session),
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ) -> DeleteResponse:
     """Remove specified tag"""
     query = """
@@ -123,7 +117,7 @@ async def delete_tag(
 async def create_tags(
     request: RouteRequest,
     req: ModifiedTag,
-    session: SessionContainer = Depends(verify_session),
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ) -> Tags:
     """Create tag"""
     query = """
@@ -140,7 +134,7 @@ async def create_tags(
 async def bulk_create_tags(
     request: RouteRequest,
     req: list[ModifiedTag],
-    session: SessionContainer = Depends(verify_session),
+    session: Annotated[SessionContainer, Depends(verify_session())],
 ) -> list[Tags]:
     """Bulk-create tags"""
     query = """

diff --git a/server/utils/router.py b/server/utils/router.py
@@ -17,14 +17,12 @@ class PartialConfig(BaseModel, frozen=True):
 
 
 class KanaeRouter(APIRouter):
-    limiter: Limiter
-
     def __init__(self, **kwargs):
         super().__init__(**kwargs)
 
         # This isn't my favorite implementation, but will do for now - Noelle
         self._config = self._load_config()
-        self.limiter = Limiter(
+        self.limiter: Limiter = Limiter(
             key_func=get_remote_address,
             storage_uri=self._config.redis_uri,
             default_limits=self._config.ratelimits,  # type: ignore