feat: add "subscription-key" as query parameter, to support Azure and…

… other APIs that wish to use API keys.
RDFLib · Nov 10, 2024 · c7c7522 · c7c7522
1 parent 45ad323
commit c7c7522
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/prez/dependencies.py b/prez/dependencies.py
@@ -599,6 +599,7 @@ async def check_unknown_params(request: Request):
         "filter",
         "order_by",
         "order_by_direction",
+        "subscription-key",
     }
     unknown_params = set(request.query_params.keys()) - known_params
     if unknown_params:

diff --git a/prez/models/query_params.py b/prez/models/query_params.py
@@ -160,6 +160,11 @@ def __init__(
             default=None,
             description="Optional: Order direction, must be 'ASC' or 'DESC'",
         ),
+        subscription_key: str = Query(
+            default=None,
+            description="An optional API Subscription key",
+            alias="subscription-key",
+        ),
     ):
         self.q = q
         self.page = page
@@ -172,6 +177,7 @@ def __init__(
         self.order_by_direction = order_by_direction
         self.filter = filter
         self.mediatype = mediatype
+        self.subscription_key = subscription_key
         self.validate_filter()
 
     def validate_filter(self):