Fix Contact/Team REST API (#5489)

nautobot · Mar 29, 2024 · a2269a9 · a2269a9
1 parent fe4b7b6
commit a2269a9
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 5 deletions.
diff --git a/changes/5489.fixed b/changes/5489.fixed
@@ -0,0 +1 @@
+Fixed REST API for Contact and Team incorrectly marking the `phone` and `email` fields as mandatory.
diff --git a/nautobot/extras/api/serializers.py b/nautobot/extras/api/serializers.py
@@ -193,10 +193,18 @@ class ContactSerializer(NautobotModelSerializer):
     class Meta:
         model = Contact
         fields = "__all__"
+        # https://www.django-rest-framework.org/api-guide/validators/#optional-fields
+        validators = []
+        extra_kwargs = {
+            "email": {"default": ""},
+            "phone": {"default": ""},
+        }
 
     def validate(self, data):
         attrs = data.copy()
         attrs.pop("teams", None)
+        validator = UniqueTogetherValidator(queryset=Contact.objects.all(), fields=("name", "phone", "email"))
+        validator(attrs, self)
         super().validate(attrs)
         return data
 
@@ -946,7 +954,18 @@ class TeamSerializer(NautobotModelSerializer):
     class Meta:
         model = Team
         fields = "__all__"
-        extra_kwargs = {"contacts": {"required": False}}
+        extra_kwargs = {
+            "contacts": {"required": False},
+            "email": {"default": ""},
+            "phone": {"default": ""},
+        }
+        # https://www.django-rest-framework.org/api-guide/validators/#optional-fields
+        validators = []
+
+    def validate(self, data):
+        validator = UniqueTogetherValidator(queryset=Team.objects.all(), fields=("name", "phone", "email"))
+        validator(data, self)
+        return super().validate(data)
 
 
 #

diff --git a/nautobot/extras/tests/test_api.py b/nautobot/extras/tests/test_api.py
@@ -409,11 +409,9 @@ def setUpTestData(cls):
             {
                 "name": "Contact 3",
                 "phone": "555-0123",
-                "email": "",
             },
             {
                 "name": "Contact 4",
-                "phone": "",
                 "email": "contact4@example.com",
             },
         ]
@@ -3613,11 +3611,9 @@ def setUpTestData(cls):
             {
                 "name": "Team 3",
                 "phone": "555-0123",
-                "email": "",
             },
             {
                 "name": "Team 4",
-                "phone": "",
                 "email": "team4@example.com",
                 "address": "Rainbow Bridge, Central NJ",
             },