add display property to Prefix model

changes/6190.fixed

@@ -0,0 +1 @@
+Added `display` property to Prefix to display namespace along with the prefix to allow differentiation of prefixes in a UI selector

nautobot/ipam/models.py

@@ -535,6 +535,10 @@ def __init__(self, *args, **kwargs):
     def __str__(self):
         return str(self.prefix)
 
+    @property
+    def display(self):
+        return f"{self.prefix}: {self.namespace}"
+
     def _deconstruct_prefix(self, prefix):
         if prefix:
             if isinstance(prefix, str):

nautobot/ipam/tests/test_api.py

@@ -443,6 +443,17 @@ def test_list_available_prefixes(self):
         for i, p in enumerate(response.data):
             self.assertEqual(p["prefix"], str(available_prefixes[i]))
 
+    def test_prefix_display_value(self):
+        """
+        Test that the `display` field is correctly populated.
+        """
+        url = reverse("ipam-api:prefix-list")
+        self.add_permissions("ipam.view_prefix")
+
+        response = self.client.get(f"{url}?depth=1", **self.header)
+        for p in response.data["results"]:
+            self.assertEqual(p["display"], f'{p["prefix"]}: {p["namespace"]["name"]}')
+
     def test_create_single_available_prefix(self):
         """
         Test retrieval of the first available prefix within a parent prefix.