feat: add all_orgs field

openedx/core/djangoapps/content_tagging/rest_api/v1/serializers.py

@@ -52,25 +52,27 @@ def validate(self, attrs: dict) -> dict:
         return attrs
 
 
-class OrgListField(serializers.RelatedField):
-    """
-    Serializer to return the list of orgs for a taxonomy
-    """
-    def to_representation(self, value):
-        """
-        Return the Organization short_name, not the TaxonomyOrg object
-        """
-        return value.org.short_name if value.org else None
-
-
 class TaxonomyOrgSerializer(TaxonomySerializer):
     """
     Serializer for Taxonomy objects inclusing the associated orgs
     """
 
-    orgs = OrgListField(many=True, read_only=True, source="taxonomyorg_set")
+    orgs = serializers.SerializerMethodField()
+    all_orgs = serializers.SerializerMethodField()
+
+    def get_orgs(self, obj) -> list[str]:
+        """
+        Return the list of orgs for the taxonomy.
+         """
+        return [taxonomy_org.org.short_name for taxonomy_org in obj.taxonomyorg_set.all() if taxonomy_org.org]
+
+    def get_all_orgs(self, obj) -> bool:
+        """
+        Return True if the taxonomy is associated with all orgs.
+        """
+        return obj.taxonomyorg_set.filter(org__isnull=True).exists()
 
     class Meta:
         model = TaxonomySerializer.Meta.model
-        fields = TaxonomySerializer.Meta.fields + ["orgs"]
-        read_only_fields = ["orgs"]
+        fields = TaxonomySerializer.Meta.fields + ["orgs", "all_orgs"]
+        read_only_fields = ["orgs", "all_orgs"]

openedx/core/djangoapps/content_tagging/rest_api/v1/tests/test_views.py

@@ -1066,6 +1066,7 @@ def test_update_org(self) -> None:
         url = TAXONOMY_ORG_DETAIL_URL.format(pk=self.tA1.pk)
         response = self.client.get(url)
         assert response.data["orgs"] == [self.orgB.short_name, self.orgX.short_name]
+        assert not response.data["all_orgs"]
 
     def test_update_all_org(self) -> None:
         """
@@ -1080,7 +1081,8 @@ def test_update_all_org(self) -> None:
         # Check that the orgs were updated
         url = TAXONOMY_ORG_DETAIL_URL.format(pk=self.tA1.pk)
         response = self.client.get(url)
-        assert response.data["orgs"] == [None]
+        assert response.data["orgs"] == []
+        assert response.data["all_orgs"]
 
     def test_update_no_org(self) -> None:
         """
@@ -1097,6 +1099,7 @@ def test_update_no_org(self) -> None:
         url = TAXONOMY_ORG_DETAIL_URL.format(pk=self.tA1.pk)
         response = self.client.get(url)
         assert response.data["orgs"] == []
+        assert not response.data["all_orgs"]
 
     @ddt.data(
         (True, ["orgX"], "Using both all_orgs and orgs parameters should throw error"),
@@ -1135,7 +1138,8 @@ def test_update_org_system_defined(self) -> None:
         # Check that the orgs didn't change
         url = TAXONOMY_ORG_DETAIL_URL.format(pk=self.st1.pk)
         response = self.client.get(url)
-        assert response.data["orgs"] == [None]
+        assert response.data["orgs"] == []
+        assert response.data["all_orgs"]
 
     @ddt.data(
         "staffA",