feat: new REST API for units in content libraries

Author: bradenmacdonald

cms/envs/common.py

@@ -1876,6 +1876,7 @@
     "openedx_learning.apps.authoring.components",
     "openedx_learning.apps.authoring.contents",
     "openedx_learning.apps.authoring.publishing",
+    "openedx_learning.apps.authoring.units",
 ]
 
 

lms/envs/common.py

@@ -3373,6 +3373,7 @@ def _make_locale_paths(settings):  # pylint: disable=missing-function-docstring
     "openedx_learning.apps.authoring.components",
     "openedx_learning.apps.authoring.contents",
     "openedx_learning.apps.authoring.publishing",
+    "openedx_learning.apps.authoring.units",
 ]
 
 

openedx/core/djangoapps/content_libraries/serializers.py

@@ -230,6 +230,28 @@ class LibraryXBlockStaticFilesSerializer(serializers.Serializer):
     files = LibraryXBlockStaticFileSerializer(many=True)
 
 
+class LibraryContainerMetadataSerializer(serializers.Serializer):
+    """
+    Serializer for LibraryXBlockMetadata
+    """
+    id = serializers.CharField(source="container_key", read_only=True)
+    container_type = serializers.CharField(source="container_key.container_type")
+    title = serializers.CharField(read_only=True)
+    last_published = serializers.DateTimeField(format=DATETIME_FORMAT, read_only=True)
+    published_by = serializers.CharField(read_only=True)
+    last_draft_created = serializers.DateTimeField(format=DATETIME_FORMAT, read_only=True)
+    last_draft_created_by = serializers.CharField(read_only=True)
+    has_unpublished_changes = serializers.BooleanField(read_only=True)
+    created = serializers.DateTimeField(format=DATETIME_FORMAT, read_only=True)
+    modified = serializers.DateTimeField(format=DATETIME_FORMAT, read_only=True)
+    tags_count = serializers.IntegerField(read_only=True)
+    collections = CollectionMetadataSerializer(many=True, required=False, read_only=True)
+
+    # When creating a new container in a library, the slug becomes the ID part of
+    # the definition key and usage key:
+    slug = serializers.CharField(write_only=True)
+
+
 class ContentLibraryBlockImportTaskSerializer(serializers.ModelSerializer):
     """
     Serializer for a Content Library block import task.

openedx/core/djangoapps/content_libraries/urls.py

@@ -39,7 +39,9 @@
             path('block_types/', views.LibraryBlockTypesView.as_view()),
             # Get the list of XBlocks in this library, or add a new one:
             path('blocks/', views.LibraryBlocksView.as_view()),
-            # Commit (POST) or revert (DELETE) all pending changes to this library:
+            # Get the list of XBlocks in this library, or add a new one:
+            path('containers/', views.LibraryContainersView.as_view()),
+            # Publish (POST) or revert (DELETE) all pending changes to this library:
             path('commit/', views.LibraryCommitView.as_view()),
             # Get the list of users/groups who have permission to view/edit/administer this library:
             path('team/', views.LibraryTeamView.as_view()),
@@ -57,6 +59,7 @@
         path('blocks/<str:usage_key_str>/', include([
             # Get metadata about a specific XBlock in this library, or delete the block:
             path('', views.LibraryBlockView.as_view()),
+            # Restore a soft-deleted block
             path('restore/', views.LibraryBlockRestore.as_view()),
             # Update collections for a given component
             path('collections/', views.LibraryBlockCollectionsView.as_view(), name='update-collections'),
@@ -69,7 +72,14 @@
             path('assets/<path:file_path>', views.LibraryBlockAssetView.as_view()),
             path('publish/', views.LibraryBlockPublishView.as_view()),
             # Future: discard changes for just this one block
-            # Future: set a block's tags (tags are stored in a Tag bundle and linked in)
+        ])),
+        # Containers are Sections, Subsections, and Units
+        path('containers/<usage_v2:container_key>/', include([
+            # Get metadata about a specific container in this library, or delete the container:
+            # path('', views.LibraryContainerView.as_view()),
+            # Update collections for a given container
+            # path('collections/', views.LibraryContainerCollectionsView.as_view(), name='update-collections-ct'),
+            # path('publish/', views.LibraryContainerPublishView.as_view()),
         ])),
         re_path(r'^lti/1.3/', include([
             path('login/', views.LtiToolLoginView.as_view(), name='lti-login'),

openedx/core/djangoapps/content_libraries/views.py

@@ -114,6 +114,7 @@
     ContentLibraryPermissionSerializer,
     ContentLibraryUpdateSerializer,
     ContentLibraryComponentCollectionsUpdateSerializer,
+    LibraryContainerMetadataSerializer,
     LibraryXBlockCreationSerializer,
     LibraryXBlockMetadataSerializer,
     LibraryXBlockTypeSerializer,
@@ -877,6 +878,34 @@ def post(self, request, usage_key_str):
         return Response({})
 
 
+@method_decorator(non_atomic_requests, name="dispatch")
+@view_auth_classes()
+class LibraryContainersView(GenericAPIView):
+    """
+    Views to work with Containers in a specific content library.
+    """
+    serializer_class = LibraryContainerMetadataSerializer
+
+    @convert_exceptions
+    @swagger_auto_schema(
+        request_body=LibraryContainerMetadataSerializer,
+        responses={200: LibraryContainerMetadataSerializer}
+    )
+    def post(self, request, lib_key_str):
+        """
+        Add a new XBlock to this content library
+        """
+        library_key = LibraryLocatorV2.from_string(lib_key_str)
+        api.require_permission_for_library_key(library_key, request.user, permissions.CAN_EDIT_THIS_CONTENT_LIBRARY)
+        serializer = LibraryContainerMetadataSerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+
+        # Create a new regular top-level block:
+        result = api.create_container(...)
+
+        return Response(LibraryContainerMetadataSerializer(result).data)
+
+
 @method_decorator(non_atomic_requests, name="dispatch")
 @view_auth_classes()
 class LibraryImportTaskViewSet(GenericViewSet):