Merge pull request #205 from netboxlabs/feature

Merge feature -> main for 0.3.0

Author: bctiemann

.github/workflows/lint-tests.yaml

@@ -23,7 +23,7 @@ jobs:
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.12"
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -37,7 +37,7 @@ jobs:
     timeout-minutes: 10
     strategy:
       matrix:
-        python-version: [ "3.10", "3.11", "3.12" ]
+        python-version: [ "3.12" ]
     services:
       redis:
         image: redis

netbox_custom_objects/__init__.py

@@ -6,6 +6,8 @@
 from django.db.utils import DatabaseError, OperationalError, ProgrammingError
 from netbox.plugins import PluginConfig
 
+from .constants import APP_LABEL as APP_LABEL
+
 
 def is_running_migration():
     """
@@ -106,11 +108,14 @@ def get_models(self, include_auto_created=False, include_swapped=False):
 
             custom_object_types = CustomObjectType.objects.all()
             for custom_type in custom_object_types:
-                # Only yield already cached models during discovery
-                if CustomObjectType.is_model_cached(custom_type.id):
-                    model = CustomObjectType.get_cached_model(custom_type.id)
-                    if model:
-                        yield model
+                model = custom_type.get_model()
+                if model:
+                    yield model
+
+                    # If include_auto_created is True, also yield through models
+                    if include_auto_created and hasattr(model, '_through_models'):
+                        for through_model in model._through_models:
+                            yield through_model
 
 
 config = CustomObjectsPluginConfig

netbox_custom_objects/api/serializers.py

@@ -115,13 +115,16 @@ class Meta:
             "id",
             "url",
             "name",
+            "verbose_name",
+            "verbose_name_plural",
+            "slug",
             "description",
             "tags",
             "created",
             "last_updated",
             "fields",
         ]
-        brief_fields = ("id", "url", "name", "description")
+        brief_fields = ("id", "url", "name", "slug", "description")
 
     def create(self, validated_data):
         return super().create(validated_data)
@@ -192,7 +195,7 @@ def get_url(self, obj):
         lookup_value = getattr(obj, "pk")
         kwargs = {
             "pk": lookup_value,
-            "custom_object_type": obj.custom_object_type.name.lower(),
+            "custom_object_type": obj.custom_object_type.slug,
         }
         request = self.context["request"]
         format = self.context.get("format")
@@ -203,7 +206,7 @@ def get_field_data(self, obj):
         return result
 
 
-def get_serializer_class(model):
+def get_serializer_class(model, skip_object_fields=False):
     model_fields = model.custom_object_type.fields.all()
 
     # Create field list including all necessary fields
@@ -230,7 +233,7 @@ def get_url(self, obj):
         lookup_value = getattr(obj, "pk")
         kwargs = {
             "pk": lookup_value,
-            "custom_object_type": obj.custom_object_type.name.lower(),
+            "custom_object_type": obj.custom_object_type.slug,
         }
         request = self.context["request"]
         format = self.context.get("format")
@@ -251,6 +254,10 @@ def get_display(self, obj):
     }
 
     for field in model_fields:
+        if skip_object_fields and field.type in [
+            CustomFieldTypeChoices.TYPE_OBJECT, CustomFieldTypeChoices.TYPE_MULTIOBJECT
+        ]:
+            continue
         field_type = field_types.FIELD_TYPE_CLASS[field.type]()
         try:
             attrs[field.name] = field_type.get_serializer_field(field)

netbox_custom_objects/api/urls.py

@@ -51,7 +51,7 @@ def get(self, request, *args, **kwargs):
         # Extra logic to populate roots for custom object type lists
         for custom_object_type in CustomObjectType.objects.all():
             local_kwargs = deepcopy(kwargs)
-            cot_name = custom_object_type.name.lower()
+            cot_name = custom_object_type.slug
             url_name = 'customobject-list'
             local_kwargs['custom_object_type'] = cot_name
             if namespace:

netbox_custom_objects/api/views.py

@@ -1,4 +1,5 @@
 from django.http import Http404
+from drf_spectacular.utils import extend_schema_view, extend_schema
 from rest_framework.routers import APIRootView
 from rest_framework.viewsets import ModelViewSet
 
@@ -18,13 +19,25 @@ class CustomObjectTypeViewSet(ModelViewSet):
     serializer_class = serializers.CustomObjectTypeSerializer
 
 
+# TODO: Need to remove this for now, check if work-around in the future.
+# There is a catch-22 spectacular get the queryset and serializer class without
+# params at startup.  The suggested workaround is to return the model empty
+# queryset, but we can't get the model without params at startup.
+@extend_schema_view(
+    list=extend_schema(exclude=True),
+    retrieve=extend_schema(exclude=True),
+    create=extend_schema(exclude=True),
+    update=extend_schema(exclude=True),
+    partial_update=extend_schema(exclude=True),
+    destroy=extend_schema(exclude=True)
+)
 class CustomObjectViewSet(ModelViewSet):
     serializer_class = serializers.CustomObjectSerializer
     model = None
 
     def get_view_name(self):
         if self.model:
-            return self.model.custom_object_type.name
+            return self.model.custom_object_type.display_name
         return 'Custom Object'
 
     def get_serializer_class(self):
@@ -33,7 +46,7 @@ def get_serializer_class(self):
     def get_queryset(self):
         try:
             custom_object_type = CustomObjectType.objects.get(
-                name__iexact=self.kwargs["custom_object_type"]
+                slug=self.kwargs["custom_object_type"]
             )
         except CustomObjectType.DoesNotExist:
             raise Http404