Merge pull request #2481 from DemocracyClub/expose-tags-in-api

Expose tags in API

ynr/apps/api/tests/test_api_next.py

@@ -287,6 +287,23 @@ def test_sopn_on_ballot(self):
             },
         )
 
+    def test_tags_on_ballot(self):
+        self.edinburgh_east_post_ballot.tags = {
+            "NUTS1": {"key": "UKM", "value": "Scotland"}
+        }
+        self.edinburgh_east_post_ballot.save()
+
+        response = self.app.get(
+            "/api/next/ballots/{}/".format(
+                self.edinburgh_east_post_ballot.ballot_paper_id
+            )
+        )
+        result = response.json
+        self.assertEqual(
+            result["tags"],
+            {"NUTS1": {"key": "UKM", "value": "Scotland"}},
+        )
+
     def test_no_results_on_ballot(self):
         response = self.app.get(
             "/api/next/ballots/{}/".format(

ynr/apps/elections/api/next/serializers.py

@@ -1,5 +1,6 @@
 from api.next.serializers import OrganizationSerializer
 from candidates import models as candidates_models
+from drf_yasg import openapi
 from drf_yasg.utils import swagger_serializer_method
 from elections import models as election_models
 from official_documents.api.next.serializers import BallotSOPNSerializer
@@ -83,6 +84,39 @@ def get_ballots(self, obj):
         ).data
 
 
+class TagsField(serializers.JSONField):
+    class Meta:
+        swagger_schema_fields = {
+            "type": openapi.TYPE_OBJECT,
+            "title": "Tags",
+            "description": """Freeform tags, but typically contain NUTS1 tags
+                    for the ballot. Don't rely on this data existing, defaults to an 
+                    empty object""",
+            "properties": {
+                "NUTS1": {
+                    "type": openapi.TYPE_OBJECT,
+                    "properties": {
+                        "key": {
+                            "type": openapi.TYPE_STRING,
+                            "example": "UKM",
+                            "description": "The key representing the NUTS1 code (e.g., UKM for Scotland).",
+                        },
+                        "value": {
+                            "type": openapi.TYPE_STRING,
+                            "example": "Scotland",
+                            "description": "The human-readable name associated with the NUTS1 code.",
+                        },
+                    },
+                    "description": "An object containing NUTS1 tag details.",
+                    "example": {"key": "UKM", "value": "Scotland"},
+                }
+            },
+            "example": {
+                "NUTS1": {"key": "UKM", "value": "Scotland"},
+            },
+        }
+
+
 class BallotSerializer(serializers.HyperlinkedModelSerializer):
     class Meta:
         model = candidates_models.Ballot
@@ -105,6 +139,7 @@ class Meta:
             "uncontested",
             "results",
             "voting_system",
+            "tags",
         )
 
     replaces = serializers.SlugRelatedField(
@@ -138,6 +173,7 @@ class Meta:
     )
     last_updated = serializers.SerializerMethodField()
     cancelled = serializers.SerializerMethodField()
+    tags = TagsField()
 
     def get_last_updated(self, instance):
         """