feat: Add page search endpoint

djangocms_rest/urls.py

@@ -30,6 +30,11 @@
         views.PageDetailView.as_view(),
         name="page-detail",
     ),
+    path(
+        "<slug:language>/page_search/",
+        views.PageSearchView.as_view(),
+        name="page-search",
+    ),
     path(
         "<slug:language>/placeholders/<int:content_type_id>/<int:object_id>/<str:slot>/",
         views.PlaceholderDetailView.as_view(),

djangocms_rest/views.py

@@ -135,6 +135,19 @@ def get_queryset(self):
             raise NotFound()
 
 
+class PageSearchView(PageListView):
+    def get(self, request, language: str | None = None) -> Response:
+        self.search_term = request.GET.get("q", "")
+        self.language = language
+        return super().get(request)
+
+    def get_queryset(self):
+        if not self.search_term:
+            return PageContent.objects.none()
+        qs = Page.objects.search(self.search_term, language=self.language, current_site_only=False).on_site(self.site)
+        return PageContent.objects.filter(page__in=qs).distinct()
+
+
 class PageTreeListView(BaseAPIView):
     permission_classes = [IsAllowedPublicLanguage]
     serializer_class = PageMetaSerializer

tests/endpoints/test_page_list.py

@@ -60,20 +60,54 @@ def test_get_paginated_list(self):
         self.assertEqual(response.status_code, 404)
 
         # GET PREVIEW
-        response = self.client.get(
-            reverse("page-list", kwargs={"language": "en"}) + "?preview"
-        )
+        response = self.client.get(reverse("page-list", kwargs={"language": "en"}) + "?preview")
         self.assertEqual(response.status_code, 403)
 
-        response = self.client.get(
-            reverse("page-list", kwargs={"language": "xx"}) + "?preview"
-        )
+        response = self.client.get(reverse("page-list", kwargs={"language": "xx"}) + "?preview")
         self.assertEqual(response.status_code, 403)
 
     # GET PREVIEW - Protected
     def test_get_protected(self):
         self.client.force_login(self.user)
-        response = self.client.get(
-            reverse("page-list", kwargs={"language": "en"}) + "?preview"
-        )
+        response = self.client.get(reverse("page-list", kwargs={"language": "en"}) + "?preview")
         self.assertEqual(response.status_code, 200)
+
+    def test_page_search(self):
+        for page in self.pages:
+            page_content = page.get_admin_content("en")
+            if hasattr(page_content, "versions"):
+                page_content.versions.first().publish(self.get_superuser())
+
+        # GET
+        response = self.client.get(reverse("page-search", kwargs={"language": "en"}) + "?q=1")
+        self.assertEqual(response.status_code, 200)
+        data = response.json()
+        results = data["results"]
+
+        # Validate REST Pagination Attributes
+        self.assertIn("count", data)
+        self.assertIn("next", data)
+        self.assertIn("previous", data)
+        self.assertIn("results", data)
+        self.assertIsInstance(results, list)
+        self.assertEqual(data["count"], 4)
+
+    def test_empty_page_search(self):
+        for page in self.pages:
+            page_content = page.get_admin_content("en")
+            if hasattr(page_content, "versions"):
+                page_content.versions.first().publish(self.get_superuser())
+
+        # GET
+        response = self.client.get(reverse("page-search", kwargs={"language": "en"}))
+        self.assertEqual(response.status_code, 200)
+        data = response.json()
+        results = data["results"]
+
+        # Validate REST Pagination Attributes
+        self.assertIn("count", data)
+        self.assertIn("next", data)
+        self.assertIn("previous", data)
+        self.assertIn("results", data)
+        self.assertIsInstance(results, list)
+        self.assertEqual(data["count"], 0)