feat: add searching discoverable reporting orgs

This commit adds the ability to search the discoverable reporting
orgs. It resolves #51.

Author: simon-20

src/register_your_data_api/routers/discoverable_reporting_orgs.py

@@ -1,8 +1,10 @@
 """Implementation for /discoverable-reporting-orgs end point"""
 
+from typing import Annotated
+
 import fastapi
 import starlette.requests
-from fastapi import Security
+from fastapi import Query, Security
 from libsuitecrm import Filter, SuiteCRM  # type: ignore
 
 from ..auth import authz
@@ -26,6 +28,14 @@ def get_discoverable_reporting_orgs(
     request: starlette.requests.Request,
     user: auth_models.UserAndCredentials = Security(authz.get_user_authnz, scopes=["ryd", "ryd:reporting_org"]),
     paging: PaginationQueryParams = fastapi.Depends(),
+    q: Annotated[
+        str | None,
+        Query(
+            min_length=2,
+            max_length=40,
+            description="The search term. Searches through the reporting organisation's human readable name.",
+        ),
+    ] = None,
 ) -> PaginatedResultsPage[DiscoverableReportingOrg]:
 
     context: Context = request.app.state.context
@@ -35,7 +45,10 @@ def get_discoverable_reporting_orgs(
     fields = get_discoverable_reporting_org_suitecrm_fields()
 
     filters = Filter()
-    filters.equal("iati_registry_discoverable", "1")
+    if q is not None:
+        search_q = q.replace("_", "\\_").replace("%", "\\%")  # Escape wildcard chars in SuiteCRM search
+        filters.op_and().equal("iati_registry_discoverable", "1").like("name", f"%{search_q}%")
+
     suitecrm_reporting_orgs = crm.get_records(
         "Accounts",
         fields=fields,
@@ -52,6 +65,6 @@ def get_discoverable_reporting_orgs(
 
     # SuiteCRM doesn't return the total_records, so we set page size = 1, limit fields to id and fetch one record
     total_records_resp = crm.get_records("Accounts", filters=filters, fields=["id"], page_number=1, page_size=1)
-    total_records = total_records_resp.get("meta", {}).get("total-pages", 1)
+    total_records = total_records_resp.get("meta", {}).get("total-pages", 0)
 
     return PaginatedResultsPage.create(discoverable_orgs, paging.page, paging.page_size, total_records, request)