fix (backend): move from deprecated example to examples

brownben · Dec 6, 2024 · d1c25ad · d1c25ad
1 parent aa81c89
commit d1c25ad
Show file tree

Hide file tree

Showing 5 changed files with 36 additions and 36 deletions.
diff --git a/backend/src/routes/competitor_pools.py b/backend/src/routes/competitor_pools.py
@@ -21,7 +21,7 @@ async def get_all_competitor_pools() -> Iterable[str]:
 async def get_leagues_in_competitor_pool(
     name: str = Path(
         title="Competitor Pool Name",
-        example="Edinburgh Winter 2020",
+        examples=["Edinburgh Winter 2020"],
     ),
 ) -> Iterable[League]:
     return await Leagues.get_by_competitor_pool(name)
@@ -31,7 +31,7 @@ async def get_leagues_in_competitor_pool(
 async def get_competitors_in_competitor_pool(
     name: str = Path(
         title="Competitor Pool Name",
-        example="Edinburgh Winter 2020",
+        examples=["Edinburgh Winter 2020"],
     ),
 ) -> Iterable[Competitor]:
     return await Competitors.get_by_pool(name)
@@ -41,7 +41,7 @@ async def get_competitors_in_competitor_pool(
 async def get_events_in_competitor_pool(
     name: str = Path(
         title="Competitor Pool Name",
-        example="Edinburgh Winter 2020",
+        examples=["Edinburgh Winter 2020"],
     ),
 ) -> Iterable[EventWithUploadKey]:
     return await Events.get_by_competitor_pool(name)
diff --git a/backend/src/routes/competitors.py b/backend/src/routes/competitors.py
@@ -41,7 +41,7 @@ async def get_competitor_details(
     id: int = Path(
         title="Competitor ID",
         description="ID of the competitor to fetch",
-        example=7,
+        examples=[7],
     ),
 ) -> Competitor:
     result = await Competitors.get_by_id(id)
@@ -58,7 +58,7 @@ async def update_competitor_details(
     id: int = Path(
         title="Competitor ID",
         description="ID of the competitor to fetch",
-        example=7,
+        examples=[7],
     ),
     authentication: bool = Depends(require_authentication),
 ) -> Message:
@@ -75,7 +75,7 @@ async def get_overview_for_competitor(
     id: int = Path(
         title="Competitor ID",
         description="ID of the competitor to fetch results for",
-        example=7,
+        examples=[7],
     ),
 ) -> CompetitorOverview:
     competitor, results, league = await asyncio.gather(

diff --git a/backend/src/routes/events.py b/backend/src/routes/events.py
@@ -70,7 +70,7 @@ async def get_event_details(
     id: str = Path(
         title="Event ID",
         description="ID of the event to fetch",
-        example="Tentsmuir2021-08-12",
+        examples=["Tentsmuir2021-08-12"],
     ),
 ) -> EventWithUploadKey:
     result = await Events.get_by_id(id)
@@ -87,7 +87,7 @@ async def update_event_details(
     id: str = Path(
         title="Event ID",
         description="ID of the event to fetch",
-        example="Tentsmuir2021-08-12",
+        examples=["Tentsmuir2021-08-12"],
     ),
     authentication: bool = Depends(require_authentication),
 ) -> Message:
@@ -109,7 +109,7 @@ async def delete_event(
     id: str = Path(
         title="Event ID",
         description="ID of the event to fetch",
-        example="Tentsmuir2021-08-12",
+        examples=["Tentsmuir2021-08-12"],
     ),
     authentication: bool = Depends(require_authentication),
 ) -> Message:
@@ -123,7 +123,7 @@ async def get_event_details_with_upload_key(
     id: str = Path(
         title="Event ID",
         description="ID of the event to fetch",
-        example="Tentsmuir2021-08-12",
+        examples=["Tentsmuir2021-08-12"],
     ),
     authentication: bool = Depends(require_authentication),
 ) -> EventWithUploadKey:
@@ -140,7 +140,7 @@ async def get_results_for_event(
     id: str = Path(
         title="Event ID",
         description="ID of the event to fetch results for",
-        example="Tentsmuir2021-08-12",
+        examples=["Tentsmuir2021-08-12"],
     ),
 ) -> EventWithResults:
     event, results, league = await asyncio.gather(

diff --git a/backend/src/routes/leagues.py b/backend/src/routes/leagues.py
@@ -99,7 +99,7 @@ async def get_league_details(
     name: str = Path(
         title="League Name",
         description="Name of the league to fetch",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
 ) -> LeagueOverviewAuthenticated:
     return await get_league(name)
@@ -110,7 +110,7 @@ async def get_league_details_with_event_upload_keys(
     name: str = Path(
         title="League Name",
         description="Name of the league to fetch",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
     authentication: bool = Depends(require_authentication),
 ) -> LeagueOverviewAuthenticated:
@@ -123,7 +123,7 @@ async def update_league_details(
     name: str = Path(
         title="League Name",
         description="Name of the league to update",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
     authentication: bool = Depends(require_authentication),
 ) -> Message:
@@ -140,7 +140,7 @@ async def delete_league(
     name: str = Path(
         title="League Name",
         description="Name of the league to delete",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
     authentication: bool = Depends(require_authentication),
 ) -> Message:
@@ -154,7 +154,7 @@ async def get_league_events(
     league_name: str = Path(
         title="League Name",
         description="Name of the league",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
 ) -> Iterable[EventWithLeagueDetailsAndUploadKey]:
     league, events = await asyncio.gather(
@@ -188,7 +188,7 @@ async def get_league_events_calendar(
     league_name: str = Path(
         title="League Name",
         description="Name of the league",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
 ) -> PlainTextResponse:
     league, events = await asyncio.gather(
@@ -241,12 +241,12 @@ async def get_league_results(
     league_name: str = Path(
         title="League Name",
         description="Name of the league to get the results for",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
     cls: str = Path(
         title="Class",
         description="Name of the class to get results for",
-        example="Long",
+        examples=["Long"],
     ),
 ) -> LeagueResultsResponse:
     league, events, league_class, league_classes, league_groups = await asyncio.gather(
@@ -345,7 +345,7 @@ async def get_league_classes(
     league_name: str = Path(
         title="League Name",
         description="Name of the league",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
 ) -> Iterable[LeagueClass]:
     league, classes = await asyncio.gather(
@@ -364,12 +364,12 @@ async def get_league_class(
     league_name: str = Path(
         title="League Name",
         description="Name of the league ",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
     cls: str = Path(
         title="Class Name",
         description="Name of the class",
-        example="Long",
+        examples=["Long"],
     ),
 ) -> LeagueClass:
     result = await LeagueClasses.get_by_name(league_name, cls)
@@ -386,7 +386,7 @@ async def create_league_class(
     league_name: str = Path(
         title="League Name",
         description="Name of the league",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
     authentication: bool = Depends(require_authentication),
 ) -> Message:
@@ -414,12 +414,12 @@ async def update_league_class(
     league_name: str = Path(
         title="League Name",
         description="Name of the league ",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
     class_name: str = Path(
         title="Class Name",
         description="Name of the class",
-        example="Long",
+        examples=["Long"],
     ),
     authentication: bool = Depends(require_authentication),
 ) -> Message:
@@ -436,12 +436,12 @@ async def delete_league_class(
     league_name: str = Path(
         title="League Name",
         description="Name of the league",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
     name: str = Path(
         title="Class Name",
         description="Name of the league class to delete",
-        example="Long",
+        examples=["Long"],
     ),
     authentication: bool = Depends(require_authentication),
 ) -> Message:
@@ -455,7 +455,7 @@ async def get_league_groups(
     league_name: str = Path(
         title="League Name",
         description="Name of the league ",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
 ) -> list[LeagueGroup]:
     league, groups = await asyncio.gather(
@@ -474,12 +474,12 @@ async def get_league_group(
     league_name: str = Path(
         title="League Name",
         description="Name of the league ",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
     group: str = Path(
         title="Group Name",
         description="Name of the group",
-        example="Sprint",
+        examples=["Sprint"],
     ),
 ) -> LeagueGroup:
     result = await LeagueGroups.get_by_name(league_name, group)
@@ -496,7 +496,7 @@ async def create_league_group(
     league_name: str = Path(
         title="League Name",
         description="Name of the league",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
     authentication: bool = Depends(require_authentication),
 ) -> Message:
@@ -524,12 +524,12 @@ async def update_league_group(
     league_name: str = Path(
         title="League Name",
         description="Name of the league ",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
     group_name: str = Path(
         title="Group Name",
         description="Name of the group",
-        example="Sprint",
+        examples=["Sprint"],
     ),
     authentication: bool = Depends(require_authentication),
 ) -> Message:
@@ -546,12 +546,12 @@ async def delete_league_group(
     league_name: str = Path(
         title="League Name",
         description="Name of the league",
-        example="Sprintelope 2021",
+        examples=["Sprintelope 2021"],
     ),
     name: str = Path(
         title="Group Name",
         description="Name of the league group to delete",
-        example="Sprint",
+        examples=["Sprint"],
     ),
     authentication: bool = Depends(require_authentication),
 ) -> Message:

diff --git a/backend/src/routes/results.py b/backend/src/routes/results.py
@@ -47,7 +47,7 @@ async def update_result(
     id: int = Path(
         title="Competitor ID",
         description="ID of the competitor to fetch",
-        example=7,
+        examples=[7],
     ),
     authentication: bool = Depends(require_authentication),
 ) -> Message: