OpenConceptLab/ocl_issues#2272 | API to get all expansions within the collection

Author: snyaggarwal

core/collections/serializers.py

@@ -546,11 +546,13 @@ class ExpansionSerializer(ModelSerializer):
     summary = SerializerMethodField()
     url = CharField(source='uri', read_only=True)
     parameters = JSONField()
+    collection_version = CharField(read_only=True, source='collection_version.version')
 
     class Meta:
         model = Expansion
         fields = (
             'mnemonic', 'id', 'parameters', 'canonical_url', 'url', 'summary', 'is_processing',
+            'collection_version'
         )
 
     def __init__(self, *args, **kwargs):
@@ -587,12 +589,13 @@ class ExpansionDetailSerializer(ModelSerializer):
     explicit_source_versions = SourceVersionListSerializer(many=True, read_only=True)
     evaluated_collection_versions = CollectionVersionListSerializer(many=True, read_only=True)
     evaluated_source_versions = SourceVersionListSerializer(many=True, read_only=True)
+    collection_version = CharField(read_only=True, source='collection_version.version')
 
     class Meta:
         model = Expansion
         fields = (
             'mnemonic', 'id', 'parameters', 'canonical_url', 'url', 'summary', 'created_on', 'created_by',
-            'is_processing', 'unresolved_repo_versions',
+            'is_processing', 'unresolved_repo_versions', 'collection_version',
             'explicit_collection_versions', 'explicit_source_versions',
             'evaluated_collection_versions', 'evaluated_source_versions',
         )

core/collections/urls.py

@@ -121,6 +121,11 @@
         views.CollectionExtrasView.as_view(),
         name='collection-extras'
     ),
+    path(
+        '<str:collection>/expansions/',
+        views.CollectionExpansionsView.as_view(),
+        name='expansion-list-collection'
+    ),
     path(
         '<str:collection>/<str:version>/',
         views.CollectionVersionRetrieveUpdateDestroyView.as_view(),

core/collections/views.py

@@ -25,7 +25,7 @@
     SOURCE_MAPPINGS,
     UNKNOWN_REFERENCE_ADDED_TO_COLLECTION_FMT)
 from core.collections.documents import CollectionDocument
-from core.collections.models import Collection, CollectionReference
+from core.collections.models import Collection, CollectionReference, Expansion
 from core.collections.search import CollectionFacetedSearch
 from core.collections.serializers import (
     CollectionDetailSerializer, CollectionListSerializer,
@@ -807,6 +807,21 @@ def create(self, request, *args, **kwargs):
                         headers=headers)
 
 
+class CollectionExpansionsView(CollectionBaseView, ListWithHeadersMixin):
+    def get_serializer_class(self):
+        if self.is_verbose():
+            return ExpansionDetailSerializer
+        return ExpansionSerializer
+
+    def get_queryset(self):
+        instance = get_object_or_404(super().get_queryset())
+        self.check_object_permissions(self.request, instance)
+        return Expansion.objects.filter(collection_version_id__in=instance.versions.values_list('id', flat=True))
+
+    def get(self, request, *args, **kwargs):
+        return self.list(request, *args, **kwargs)
+
+
 class CollectionVersionExpansionBaseView(CollectionBaseView):
     serializer_class = ExpansionSerializer
 

core/integration_tests/tests_collections.py

@@ -3857,3 +3857,36 @@ def test_get(self):
         self.assertEqual(response.data[0]['mnemonic'], 'e1')
         self.assertEqual(response.data[0]['parameters'], expansion.parameters)
         self.assertEqual(response.data[0]['summary'], {'active_concepts': 0, 'active_mappings': 0})
+
+
+class CollectionExpansionsViewTest(OCLAPITestCase):
+    def setUp(self):
+        super().setUp()
+        self.collection = OrganizationCollectionFactory()
+        self.token = self.collection.created_by.get_token()
+
+    def test_get(self):
+        collection_v1 = OrganizationCollectionFactory(
+            mnemonic=self.collection.mnemonic, organization=self.collection.organization, version='v1'
+        )
+
+        response = self.client.get(
+            self.collection.url + 'expansions/',
+            format='json'
+        )
+
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(response.data, [])
+
+        ExpansionFactory(mnemonic='e1-head', collection_version=self.collection)
+        ExpansionFactory(mnemonic='e1-v1', collection_version=collection_v1)
+        ExpansionFactory(mnemonic='e2-head', collection_version=self.collection)
+
+        response = self.client.get(
+            self.collection.url + 'expansions/',
+            format='json'
+        )
+
+        self.assertEqual(response.status_code, 200)
+        self.assertEqual(len(response.data), 3)
+        self.assertEqual([expansion['mnemonic'] for expansion in response.data], ['e2-head', 'e1-v1', 'e1-head'])