An open source, non-profit web search engine
Use q as the parameter name for v2 of search API
Daoud Clarke589b528df7d3
diff --git a/mwmbl/tinysearchengine/search.py b/mwmbl/tinysearchengine/search.pyindex e6ea11f..5a20ae5 100644--- a/mwmbl/tinysearchengine/search.py+++ b/mwmbl/tinysearchengine/search.py@@ -271,12 +271,12 @@ def _register_search_v2(r: Router | NinjaAPI, ranker: HeuristicRanker):"The response includes `monthly_usage` (requests used this month) and ""`monthly_limit` (your plan's monthly cap); both are `null` for ""unauthenticated requests.\n\n"- "**Query parameter:** `s` — the search query string (required)."+ "**Query parameter:** `q` — the search query string (required)."),openapi_extra={"parameters": [{- "name": "s",+ "name": "q","in": "query","required": True,"schema": {"type": "string", "example": "python tutorial"},@@ -284,7 +284,7 @@ def _register_search_v2(r: Router | NinjaAPI, ranker: HeuristicRanker):]},)- def search(request, s: str):+ def search(request, q: str):raw_key = request.headers.get("X-API-Key")api_key = Noneif raw_key:@@ -318,9 +318,9 @@ def _register_search_v2(r: Router | NinjaAPI, ranker: HeuristicRanker):monthly_limit = Nonemonthly_usage = None- results = ranker.search(s, [])+ results = ranker.search(q, [])return SearchResponse(- results=[format_result(result, s) for result in results],+ results=[format_result(result, q) for result in results],monthly_usage=monthly_usage,monthly_limit=monthly_limit,)diff --git a/test/test_search_api_key.py b/test/test_search_api_key.pyindex 086bc2b..05a090e 100644--- a/test/test_search_api_key.py+++ b/test/test_search_api_key.py@@ -257,7 +257,7 @@ def test_delete_nonexistent_key_returns_404(api_client, access_token):@pytest.mark.django_dbdef test_search_missing_key_returns_results_with_null_usage(api_client):"""Unauthenticated requests are allowed; usage fields are null."""- response = api_client.get("/api/v2/search/?s=python")+ response = api_client.get("/api/v2/search/?q=python")assert response.status_code == 200data = response.json()assert data["monthly_usage"] is None@@ -266,7 +266,7 @@ def test_search_missing_key_returns_results_with_null_usage(api_client):@pytest.mark.django_dbdef test_search_invalid_key(api_client):- response = api_client.get("/api/v2/search/?s=python", **api_key_header("invalid-key"))+ response = api_client.get("/api/v2/search/?q=python", **api_key_header("invalid-key"))assert response.status_code == 401@@ -274,7 +274,7 @@ def test_search_invalid_key(api_client):def test_search_crawl_scoped_key_rejected(api_client, crawl_api_key):"""A crawl-scoped key must not grant access to the search endpoint."""response = api_client.get(- "/api/v2/search/?s=python",+ "/api/v2/search/?q=python",**api_key_header(crawl_api_key.raw_key),)assert response.status_code == 401@@ -290,7 +290,7 @@ def test_search_with_valid_key(api_client, search_api_key):patch("mwmbl.tinysearchengine.search.get_monthly_count", return_value=0), \patch("mwmbl.tinysearchengine.search.increment_monthly", return_value=1):response = api_client.get(- "/api/v2/search/?s=python",+ "/api/v2/search/?q=python",**api_key_header(search_api_key.raw_key),)assert response.status_code == 200@@ -304,7 +304,7 @@ def test_search_response_includes_usage_fields(api_client, search_api_key):patch("mwmbl.tinysearchengine.search.increment_monthly", return_value=6), \patch("mwmbl.tinysearchengine.rank.HeuristicRanker.search", return_value=[]):response = api_client.get(- "/api/v2/search/?s=python",+ "/api/v2/search/?q=python",**api_key_header(search_api_key.raw_key),)assert response.status_code == 200@@ -322,7 +322,7 @@ def test_search_response_includes_usage_fields(api_client, search_api_key):def test_search_rate_limit_exceeded(api_client, search_api_key):with patch("mwmbl.tinysearchengine.search.check_rate_limit", return_value=False):response = api_client.get(- "/api/v2/search/?s=python",+ "/api/v2/search/?q=python",**api_key_header(search_api_key.raw_key),)assert response.status_code == 429@@ -335,7 +335,7 @@ def test_search_monthly_quota_exceeded(api_client, search_api_key):with patch("mwmbl.tinysearchengine.search.check_rate_limit", return_value=True), \patch("mwmbl.tinysearchengine.search.get_monthly_count", return_value=limit):response = api_client.get(- "/api/v2/search/?s=python",+ "/api/v2/search/?q=python",**api_key_header(search_api_key.raw_key),)assert response.status_code == 429@@ -354,7 +354,7 @@ def test_search_monthly_quota_exceeded_pro_no_upgrade_message(api_client, searchwith patch("mwmbl.tinysearchengine.search.check_rate_limit", return_value=True), \patch("mwmbl.tinysearchengine.search.get_monthly_count", return_value=limit):response = api_client.get(- "/api/v2/search/?s=python",+ "/api/v2/search/?q=python",**api_key_header(search_api_key.raw_key),)assert response.status_code == 429@@ -566,7 +566,7 @@ def test_subscription_usage_matches_search_response(api_client, access_token, ve)cache.delete(_monthly_key(verified_user.id))- search_resp = api_client.get("/api/v2/search/?s=python", **api_key_header(raw_key))+ search_resp = api_client.get("/api/v2/search/?q=python", **api_key_header(raw_key))assert search_resp.status_code == 200search_usage = search_resp.json()["monthly_usage"]assert search_usage == 1