feat: Enable Wagtail API

cms/models.py

@@ -44,6 +44,7 @@
 from wagtail.models import Orderable, Page, PageManager, PageQuerySet
 from wagtail.snippets.models import register_snippet
 from wagtailmetadata.models import MetadataPageMixin
+from wagtail.api import APIField
 
 from blog.api import fetch_blog
 from cms.api import filter_and_sort_catalog_pages
@@ -98,6 +99,8 @@
 from mitxpro.features import CATALOG_LANGUAGE_FILTER
 from mitxpro.utils import now_in_utc
 from mitxpro.views import get_base_context
+from courses.serializers import CourseSerializer, ProgramSerializer
+from .wagtail_api_serializers import ProductChildPageSerializer
 
 
 class DisableSitemapURLMixin:
@@ -1142,6 +1145,10 @@ def save(self, clean=True, user=None, log_action=False, **kwargs):  # noqa: FBT0
                 child_class.objects.filter(featured=True).update(featured=False)
         super().save(clean=clean, user=user, log_action=log_action, **kwargs)
 
+    api_fields = [
+        APIField("child_pages", serializer=ProductChildPageSerializer()),
+    ]
+
     @property
     def product(self):
         """Returns the courseware object (Course, Program) associated with this page"""
@@ -1303,6 +1310,11 @@ class Meta:
         help_text="The program for this page",
     )
 
+    api_fields = [
+        APIField("program", serializer=ProgramSerializer()),
+        *ProductPage.api_fields,
+    ]
+
     @property
     def course_pages(self):
         """
@@ -1440,6 +1452,11 @@ class Meta:
     ]
     base_form_class = CoursewareForm
 
+    api_fields = [
+        APIField("course", serializer=CourseSerializer()),
+        *ProductPage.api_fields,
+    ]
+
     @cached_property
     def course_with_related_objects(self):
         """

cms/wagtail_api.py

@@ -0,0 +1,47 @@
+from django.db.models import F
+from rest_framework.permissions import IsAdminUser
+from wagtail.api.v2.router import WagtailAPIRouter
+from wagtail.api.v2.views import PagesAPIViewSet
+from wagtail.images.api.v2.views import ImagesAPIViewSet
+from wagtail.documents.api.v2.views import DocumentsAPIViewSet
+
+from .wagtail_api_filters import ReadableIDFilter
+
+
+class AdminOnlyViewSetMixin:
+    permission_classes = (IsAdminUser,)
+
+
+class CustomPagesAPIViewSet(AdminOnlyViewSetMixin, PagesAPIViewSet):
+    filter_backends = [ReadableIDFilter] + PagesAPIViewSet.filter_backends
+    meta_fields = PagesAPIViewSet.meta_fields + ["live", "last_published_at"]
+    listing_default_fields = PagesAPIViewSet.listing_default_fields + [
+        "live",
+        "last_published_at",
+    ]
+    known_query_parameters = PagesAPIViewSet.known_query_parameters.union(
+        ["readable_id"]
+    )
+
+    def get_queryset(self):
+        queryset = super().get_queryset()
+        model_type = self.request.GET.get("type", None)
+        if model_type == "cms.CoursePage":
+            queryset = queryset.annotate(readable_id=F("course__readable_id"))
+        elif model_type == "cms.ProgramPage":
+            queryset = queryset.annotate(readable_id=F("program__readable_id"))
+        return queryset
+
+
+class CustomImagesAPIViewSet(AdminOnlyViewSetMixin, ImagesAPIViewSet):
+    pass
+
+
+class CustomDocumentsAPIViewSet(AdminOnlyViewSetMixin, DocumentsAPIViewSet):
+    pass
+
+
+api_router = WagtailAPIRouter("wagtailapi")
+api_router.register_endpoint("pages", CustomPagesAPIViewSet)
+api_router.register_endpoint("images", CustomImagesAPIViewSet)
+api_router.register_endpoint("documents", CustomDocumentsAPIViewSet)

cms/wagtail_api_filters.py

@@ -0,0 +1,10 @@
+from rest_framework.filters import BaseFilterBackend
+
+
+class ReadableIDFilter(BaseFilterBackend):
+    def filter_queryset(self, request, queryset, view):
+        field_name = "readable_id"
+        if field_name in request.GET:
+            value = request.GET[field_name].replace(" ", "+")
+            queryset = queryset.filter(**{field_name: value})
+        return queryset

cms/wagtail_api_serializers.py

@@ -0,0 +1,29 @@
+from rest_framework.fields import Field
+
+from wagtail.models import Page
+from wagtail.api.v2.serializers import get_serializer_class
+from wagtail.api.v2.views import PagesAPIViewSet
+
+
+class ProductChildPageSerializer(Field):
+    def to_representation(self, value):
+        if hasattr(value, "all"):
+            base_context = {"view": PagesAPIViewSet()}
+            context = {**base_context, **getattr(self, "context", {})}
+            return [self.serialize_page(page, context) for page in value.all()]
+        return self.serialize_page(value, self.context)
+
+    def serialize_page(self, page, context):
+        if not isinstance(page, Page):
+            return None
+
+        model = page.specific.__class__
+
+        serializer = get_serializer_class(
+            model,
+            PagesAPIViewSet.body_fields + PagesAPIViewSet.meta_fields,
+            PagesAPIViewSet.meta_fields,
+            base=PagesAPIViewSet.base_serializer_class,
+        )
+
+        return serializer(page.specific, context=context).data

courses/serializers.py

@@ -8,7 +8,6 @@
 from django.templatetags.static import static
 from rest_framework import serializers
 
-from cms.models import ProductPage
 from courses import models
 from ecommerce.serializers import CompanySerializer
 
@@ -120,7 +119,7 @@ class BaseProductSerializer(serializers.ModelSerializer):
     language = serializers.SerializerMethodField()
 
     class Meta:
-        model = ProductPage
+        model = "cms.ProductPage"
         fields = [
             "url",
             "description",

mitxpro/settings.py

@@ -175,6 +175,7 @@
     "wagtailmetadata",
     "modelcluster",
     "taggit",
+    "wagtail.api.v2",
     # django-robots
     "robots",
     # Put our apps after this point

mitxpro/urls.py

@@ -28,6 +28,8 @@
 from wagtail.images.views.serve import ServeView
 from wagtail.utils.urlpatterns import decorate_urlpatterns
 
+from cms.wagtail_api import api_router
+
 from mitxpro.views import (
     AppContextView,
     cms_signin_redirect_to_site_signin,
@@ -62,6 +64,7 @@
         path("", include("sheets.urls")),
         path("", include("mail.urls")),
         path("api/v1/", include("mitol.digitalcredentials.urls")),
+        path("api/v2/", api_router.urls),
         path("", include("mitol.mail.urls")),
         path("boeing/", include(("voucher.urls", "voucher"))),
         path("api/app_context", AppContextView.as_view(), name="api-app_context"),