Closes #9623: Implement saved filters (#10801)

* Initial work on saved filters

* Return only enabled/shared filters

* Add tests

* Clean up filtering of usable SavedFilters

netbox/extras/api/nested_serializers.py

@@ -13,6 +13,7 @@ __all__ = [
     'NestedImageAttachmentSerializer',
     'NestedJobResultSerializer',
     'NestedJournalEntrySerializer',
+    'NestedSavedFilterSerializer',
     'NestedTagSerializer',  # Defined in netbox.api.serializers
     'NestedWebhookSerializer',
 ]
@@ -58,6 +59,14 @@ class NestedExportTemplateSerializer(WritableNestedSerializer):
         fields = ['id', 'url', 'display', 'name']
 
 
+class NestedSavedFilterSerializer(WritableNestedSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='extras-api:savedfilter-detail')
+
+    class Meta:
+        model = models.SavedFilter
+        fields = ['id', 'url', 'display', 'name']
+
+
 class NestedImageAttachmentSerializer(WritableNestedSerializer):
     url = serializers.HyperlinkedIdentityField(view_name='extras-api:imageattachment-detail')
 

netbox/extras/api/serializers.py

@@ -39,6 +39,7 @@ __all__ = (
     'ReportDetailSerializer',
     'ReportSerializer',
     'ReportInputSerializer',
+    'SavedFilterSerializer',
     'ScriptDetailSerializer',
     'ScriptInputSerializer',
     'ScriptLogMessageSerializer',
@@ -149,6 +150,25 @@ class ExportTemplateSerializer(ValidatedModelSerializer):
         ]
 
 
+#
+# Saved filters
+#
+
+class SavedFilterSerializer(ValidatedModelSerializer):
+    url = serializers.HyperlinkedIdentityField(view_name='extras-api:savedfilter-detail')
+    content_types = ContentTypeField(
+        queryset=ContentType.objects.all(),
+        many=True
+    )
+
+    class Meta:
+        model = SavedFilter
+        fields = [
+            'id', 'url', 'display', 'content_types', 'name', 'description', 'user', 'weight',
+            'enabled', 'shared', 'parameters', 'created', 'last_updated',
+        ]
+
+
 #
 # Tags
 #

netbox/extras/api/urls.py

@@ -5,43 +5,19 @@ from . import views
 router = NetBoxRouter()
 router.APIRootView = views.ExtrasRootView
 
-# Webhooks
 router.register('webhooks', views.WebhookViewSet)
-
-# Custom fields
 router.register('custom-fields', views.CustomFieldViewSet)
-
-# Custom links
 router.register('custom-links', views.CustomLinkViewSet)
-
-# Export templates
 router.register('export-templates', views.ExportTemplateViewSet)
-
-# Tags
+router.register('saved-filters', views.SavedFilterViewSet)
 router.register('tags', views.TagViewSet)
-
-# Image attachments
 router.register('image-attachments', views.ImageAttachmentViewSet)
-
-# Journal entries
 router.register('journal-entries', views.JournalEntryViewSet)
-
-# Config contexts
 router.register('config-contexts', views.ConfigContextViewSet)
-
-# Reports
 router.register('reports', views.ReportViewSet, basename='report')
-
-# Scripts
 router.register('scripts', views.ScriptViewSet, basename='script')
-
-# Change logging
 router.register('object-changes', views.ObjectChangeViewSet)
-
-# Job Results
 router.register('job-results', views.JobResultViewSet)
-
-# ContentTypes
 router.register('content-types', views.ContentTypeViewSet)
 
 app_name = 'extras-api'

netbox/extras/api/views.py

@@ -1,4 +1,5 @@
 from django.contrib.contenttypes.models import ContentType
+from django.db.models import Q
 from django.http import Http404
 from django_rq.queues import get_connection
 from rest_framework import status
@@ -98,6 +99,17 @@ class ExportTemplateViewSet(NetBoxModelViewSet):
     filterset_class = filtersets.ExportTemplateFilterSet
 
 
+#
+# Saved filters
+#
+
+class SavedFilterViewSet(NetBoxModelViewSet):
+    metadata_class = ContentTypeMetadata
+    queryset = SavedFilter.objects.all()
+    serializer_class = serializers.SavedFilterSerializer
+    filterset_class = filtersets.SavedFilterFilterSet
+
+
 #
 # Tags
 #