Merge pull request #27 from questionlp/develop

Prepare for Stats API v1.0 Deprecation and Deactivation
questionlp · Jan 29, 2023 · 23df8ff · 23df8ff
2 parents 4db68f5 + b22804b
commit 23df8ff
Show file tree

Hide file tree

Showing 32 changed files with 58 additions and 100 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,12 @@
 # Changes
 
+## 2.1.2
+
+### Application Changes
+
+- Add `/v1.0` and `/v1.0/docs` routes that redirect back to `/` as part of deprecating Stats API v1.0
+- Remove links to Stats API v1.0 docs and update v1.0 deprecation message
+
 ## 2.1.1
 
 ### Application Changes

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 
 The Stats API is written in Python and is built on [FastAPI](https://fastapi.tiangolo.com/) and provides endpoints that can be used to query guest, host, location, panelist, scorekeeper, and show data from a copy of the [Wait Wait Don't Tell Me! Stats database](https://github.com/questionlp/wwdtm_database).
 
-If you're looking for the version 1.0 of the API, check out the [api.wwdt.me](https://github.com/questionlp/api.wwdt.me) repository.
+Please note that version 1.0 of the Stats API has now been deprecated.
 
 ## Requirements
 

diff --git a/app/__init__.py b/app/__init__.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """FastAPI application __init__.py for api.wwdt.me"""
diff --git a/app/config.py b/app/config.py
@@ -1,15 +1,15 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """Application Configuration"""
 
 import json
 from typing import Any, Dict
 
 API_VERSION = "2.0"
-APP_VERSION = "2.1.1"
+APP_VERSION = "2.1.2"
 
 
 def load_config(

diff --git a/app/main.py b/app/main.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """FastAPI main application for api.wwdt.me"""
 
@@ -47,7 +47,6 @@
 config = load_config()
 
 
-# region Generic Routes
 @app.get("/", include_in_schema=False, response_class=HTMLResponse)
 @app.head("/", include_in_schema=False, response_class=HTMLResponse)
 async def default_page(request: Request):
@@ -104,7 +103,17 @@ async def redoc_redirect_sub():
     return RedirectResponse(f"/v{API_VERSION}/docs", status_code=301)
 
 
-# endregion
+@app.get("/v1.0", include_in_schema=False, response_class=RedirectResponse)
+@app.head("/v1.0", include_in_schema=False, response_class=RedirectResponse)
+async def api_v1_redirect():
+    return RedirectResponse("/", status_code=301)
+
+
+@app.get("/v1.0/docs", include_in_schema=False, response_class=RedirectResponse)
+@app.head("/v1.0/docs", include_in_schema=False, response_class=RedirectResponse)
+async def api_v1_docs_redirect():
+    return RedirectResponse("/", status_code=301)
+
 
 # Add the router modules for Guests, Hosts, Locations, Panelists,
 # Scorekeepers, Shows and Version

diff --git a/app/metadata.py b/app/metadata.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """FastAPI Metadata for api.wwdt.me"""
 

diff --git a/app/models/guests.py b/app/models/guests.py
@@ -1,15 +1,14 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """Guests Models"""
 
 from typing import List, Optional, Union
 from pydantic import BaseModel, conint, Field
 
 
-# region Models
 class Guest(BaseModel):
     """Not My Job Guest Information"""
 
@@ -69,6 +68,3 @@ class GuestsDetails(BaseModel):
     """List of Not My Job Guest Details"""
 
     guests: List[GuestDetails] = Field(title="List of Guest Details")
-
-
-# endregion
diff --git a/app/models/hosts.py b/app/models/hosts.py
@@ -1,15 +1,14 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """Hosts Models"""
 
 from typing import List, Optional, Union
 from pydantic import BaseModel, conint, Field
 
 
-# region Host Models
 class Host(BaseModel):
     """Host Information"""
 
@@ -67,6 +66,3 @@ class HostsDetails(BaseModel):
     """List of Host Details"""
 
     hosts: List[HostDetails] = Field(title="List of Host Details")
-
-
-# endregion
diff --git a/app/models/locations.py b/app/models/locations.py
@@ -1,15 +1,14 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """Locations Models"""
 
 from typing import List, Optional
 from pydantic import BaseModel, conint, Field
 
 
-# region Location Models
 class Location(BaseModel):
     """Location Information"""
 
@@ -67,6 +66,3 @@ class LocationsDetails(BaseModel):
     """List of Location Details"""
 
     locations: List[LocationDetails] = Field(title="List of Location Details")
-
-
-# endregion
diff --git a/app/models/panelists.py b/app/models/panelists.py
@@ -1,15 +1,14 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """Panelists Models"""
 
 from typing import List, Optional, Tuple
 from pydantic import BaseModel, conint, Field
 
 
-# region Panelist Models
 class Panelist(BaseModel):
     """Panelist Information"""
 
@@ -217,6 +216,3 @@ class PanelistScoresGroupedOrderedPair(BaseModel):
         "number of times that score "
         "has been earned",
     )
-
-
-# endregion
diff --git a/app/models/scorekeepers.py b/app/models/scorekeepers.py
@@ -1,15 +1,14 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """Scorekeepers Models"""
 
 from typing import List, Optional, Union
 from pydantic import BaseModel, conint, Field
 
 
-# region Scorekeeper Models
 class Scorekeeper(BaseModel):
     """Scorekeeper Information"""
 
@@ -70,6 +69,3 @@ class ScorekeepersDetails(BaseModel):
     """List of Scorekeeper Details"""
 
     scorekeepers: List[ScorekeeperDetails] = Field(title="List of Scorekeeper Details")
-
-
-# endregion
diff --git a/app/models/shows.py b/app/models/shows.py
@@ -1,15 +1,14 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """Shows Models"""
 
 from typing import List, Optional, Union
 from pydantic import BaseModel, conint, Field
 
 
-# region Shows Models
 class Show(BaseModel):
     """Show Information"""
 
@@ -133,6 +132,3 @@ class ShowDates(BaseModel):
     """List of Show Dates in ISO format (YYYY-MM-DD)"""
 
     shows: List[str] = Field(title="List of Show Dates")
-
-
-# endregion
diff --git a/app/models/version.py b/app/models/version.py
@@ -1,20 +1,16 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """App Version Models"""
 
 from pydantic import BaseModel, Field
 
 
-# region App Version Models
 class Version(BaseModel):
     """Wait Wait Stats API and Application Version Information"""
 
     api: str = Field(title="Wait Wait Stats API Version")
     app: str = Field(title="Application Version")
     wwdtm: str = Field(title="wwdtm Version")
-
-
-# endregion
diff --git a/app/routers/__init__.py b/app/routers/__init__.py
@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """FastAPI application routers __init__.py for api.wwdt.me"""
diff --git a/app/routers/guests.py b/app/routers/guests.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """API routes for Not My Job Guests endpoints"""
 

diff --git a/app/routers/hosts.py b/app/routers/hosts.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """API routes for Hosts endpoints"""
 
@@ -24,7 +24,6 @@
 _database_connection = mysql.connector.connect(**_database_config)
 
 
-# region Routes
 @router.get(
     "",
     summary="Retrieve Information for All Hosts",
@@ -222,6 +221,3 @@ async def get_host_details_by_slug(host_slug: constr(strip_whitespace=True)):
             detail="Database error occurred while trying to "
             "retrieve host information",
         )
-
-
-# endregion
diff --git a/app/routers/locations.py b/app/routers/locations.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """API routes for Locations endpoints"""
 
@@ -24,7 +24,6 @@
 _database_connection = mysql.connector.connect(**_database_config)
 
 
-# region Routes
 @router.get(
     "",
     summary="Retrieve Information for All Locations",
@@ -234,6 +233,3 @@ async def get_location_recordings_by_slug(location_slug: constr(strip_whitespace
             detail="Database error occurred while trying to "
             "retrieve location information",
         )
-
-
-# endregion
diff --git a/app/routers/panelists.py b/app/routers/panelists.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """API routes for Panelists endpoints"""
 
@@ -27,7 +27,6 @@
 _database_connection = mysql.connector.connect(**_database_config)
 
 
-# region Routes
 @router.get(
     "",
     summary="Retrieve Information for All Panelists",
@@ -483,6 +482,3 @@ async def get_panelist_scores_ordered_pair_by_slug(
             detail="Database error occurred while trying to "
             "retrieve panelist scores",
         )
-
-
-# endregion
diff --git a/app/routers/scorekeepers.py b/app/routers/scorekeepers.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """API routes for Scorekeeper endpoints"""
 
@@ -24,7 +24,6 @@
 _database_connection = mysql.connector.connect(**_database_config)
 
 
-# region Routes
 @router.get(
     "",
     summary="Retrieve Information for All Scorekeepers",
@@ -239,6 +238,3 @@ async def get_scorekeeper_details_by_slug(
             detail="Database error occurred while trying to "
             "retrieve scorekeeper information",
         )
-
-
-# endregion
diff --git a/app/routers/shows.py b/app/routers/shows.py
@@ -1,7 +1,7 @@
 # -*- coding: utf-8 -*-
 # vim: set noai syntax=python ts=4 sw=4:
 #
-# Copyright (c) 2018-2022 Linh Pham
+# Copyright (c) 2018-2023 Linh Pham
 # api.wwdt.me is released under the terms of the Apache License 2.0
 """API routes for Scorekeeper endpoints"""
 
@@ -27,7 +27,6 @@
 _database_connection = mysql.connector.connect(**_database_config)
 
 
-# region Routes
 @router.get(
     "",
     summary="Retrieve Information for All Shows",
@@ -627,6 +626,3 @@ async def get_shows_recent():
             detail="Database error occurred while retrieving "
             "shows from the database",
         )
-
-
-# endregion