add query param to search registry records.

news/1859.feature

@@ -0,0 +1 @@
+Add search param to querystring for registry listing. @Faakhir30

src/plone/restapi/serializer/registry.py

@@ -6,19 +6,19 @@
 from zope.component import getMultiAdapter
 from zope.interface import implementer
 from zope.publisher.interfaces import IRequest
+from zope.interface import Interface
 
 
 @implementer(ISerializeToJson)
-@adapter(IRegistry, IRequest)
+@adapter(IRegistry, IRequest, Interface)
 class SerializeRegistryToJson:
-    def __init__(self, registry, request):
+    def __init__(self, registry, request, records=None):
         self.registry = registry
         self.request = request
+        self.records = records or registry.records
 
     def __call__(self):
-        records = self.registry.records
-        # Batch keys, because that is a simple BTree
-        batch = HypermediaBatch(self.request, list(records))
+        batch = HypermediaBatch(self.request, list(self.records.keys()))
 
         results = {}
         results["@id"] = batch.canonical_url
@@ -27,7 +27,7 @@ def __call__(self):
             results["batching"] = batch.links
 
         def make_item(key):
-            record = records[key]
+            record = self.records[key]
             schema = getMultiAdapter(
                 (record.field, record, self.request), IJsonSchemaProvider
             )

src/plone/restapi/services/registry/get.py

@@ -35,5 +35,15 @@ def reply(self):
             value = registry[self._get_record_name]
             return json_compatible(value)
         else:  # batched listing
-            serializer = getMultiAdapter((registry, self.request), ISerializeToJson)
+            records_dict = dict(**registry.records)
+            if q := self.request.form.get("q"):
+                filtered_records = {}
+                for key in records_dict.keys():
+                    if key.startswith(q):
+                        filtered_records[key] = records_dict[key]
+                records_dict = filtered_records
+            serializer = getMultiAdapter(
+                (registry, self.request, records_dict),
+                ISerializeToJson,
+            )
             return serializer()

src/plone/restapi/tests/http-examples/registry_get_list_filtered.req

@@ -0,0 +1,3 @@
+GET /plone/@registry?q=Products.CMFPlone HTTP/1.1
+Accept: application/json
+Authorization: Basic YWRtaW46c2VjcmV0

src/plone/restapi/tests/http-examples/registry_get_list_filtered.resp

@@ -0,0 +1,57 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+    "@id": "http://localhost:55001/plone/@registry?q=Products.CMFPlone",
+    "items": [
+        {
+            "name": "Products.CMFPlone.i18nl10n.override_dateformat.Enabled",
+            "schema": {
+                "properties": {
+                    "description": "Override the translation machinery",
+                    "factory": "Yes/No",
+                    "title": "Enabled",
+                    "type": "boolean"
+                }
+            },
+            "value": false
+        },
+        {
+            "name": "Products.CMFPlone.i18nl10n.override_dateformat.date_format_long",
+            "schema": {
+                "properties": {
+                    "description": "Default value: %Y-%m-%d %H:%M (2038-01-19 03:14)",
+                    "factory": "Text line (String)",
+                    "title": "old ZMI property: localLongTimeFormat",
+                    "type": "string"
+                }
+            },
+            "value": "%Y-%m-%d %H:%M"
+        },
+        {
+            "name": "Products.CMFPlone.i18nl10n.override_dateformat.date_format_short",
+            "schema": {
+                "properties": {
+                    "description": "Default value: %Y-%m-%d (2038-01-19)",
+                    "factory": "Text line (String)",
+                    "title": "old ZMI property: localTimeFormat",
+                    "type": "string"
+                }
+            },
+            "value": "%Y-%m-%d"
+        },
+        {
+            "name": "Products.CMFPlone.i18nl10n.override_dateformat.time_format",
+            "schema": {
+                "properties": {
+                    "description": "Default value: %H:%M (03:14)",
+                    "factory": "Text line (String)",
+                    "title": "old ZMI property: localTimeOnlyFormat",
+                    "type": "string"
+                }
+            },
+            "value": "%H:%M"
+        }
+    ],
+    "items_total": 4
+}

src/plone/restapi/tests/test_documentation.py

@@ -517,6 +517,10 @@ def test_documentation_registry_get_list(self):
         response = self.api_session.get("/@registry")
         save_request_and_response_for_docs("registry_get_list", response)
 
+    def test_documentation_registry_get_list_filtered(self):
+        response = self.api_session.get("/@registry?q=Products.CMFPlone")
+        save_request_and_response_for_docs("registry_get_list_filtered", response)
+
     def test_documentation_types(self):
         response = self.api_session.get("/@types")
         save_request_and_response_for_docs("types", response)

src/plone/restapi/tests/test_registry_serializer.py

@@ -51,3 +51,16 @@ def test_structure(self):
         self.assertEqual(set(item["schema"]), {"properties"})
         self.assertEqual(item["name"], "foo.bar")
         self.assertEqual(item["value"], "Lorem Ipsum")
+
+    def test_filtered(self):
+        registry = Registry()
+        registry.records["foo.bar"] = Record(
+            field.TextLine(title="Foo Bar"), "Lorem Ipsum"
+        )
+        registry.records["foo.baz"] = Record(
+            field.TextLine(title="Foo Baz"), "Lorem Ipsum"
+        )
+        obj = self.serialize(registry, [registry.records["foo.bar"]])
+        self.assertEqual(len(obj["items"]), 1)
+        self.assertEqual(obj["items"][0]["name"], "foo.bar")
+        self.assertEqual(obj["items"][0]["value"], "Lorem Ipsum")