Merge pull request #2520 from stveit/module-endpoint

Module endpoint

python/nav/web/api/v1/serializers.py

@@ -271,10 +271,38 @@ class Meta(object):
         fields = ('id', 'cabling', 'split')
 
 
+class NetboxInlineSerializer(serializers.ModelSerializer):
+    """Serializer for including netbox information in other serializers"""
+
+    class Meta(object):
+        model = manage.Netbox
+        fields = ('id', 'sysname')
+
+
+class DeviceSerializer(serializers.ModelSerializer):
+    """Serializer for the device model"""
+
+    class Meta(object):
+        model = manage.Device
+        fields = '__all__'
+
+
+class ModuleInlineSerializer(serializers.ModelSerializer):
+    """Serializer for including module information in other serializers"""
+
+    object_url = serializers.CharField(source='get_absolute_url')
+
+    class Meta(object):
+        model = manage.Module
+        fields = '__all__'
+
+
 class ModuleSerializer(serializers.ModelSerializer):
     """Serializer for the module model"""
 
     object_url = serializers.CharField(source='get_absolute_url')
+    device = DeviceSerializer()
+    netbox = NetboxInlineSerializer()
 
     class Meta(object):
         model = manage.Module
@@ -315,7 +343,7 @@ class InterfaceSerializer(serializers.ModelSerializer):
     """Serializer for the interface model"""
 
     patches = SpecificPatchSerializer()
-    module = ModuleSerializer()
+    module = ModuleInlineSerializer()
     object_url = serializers.CharField(source='get_absolute_url')
     to_netbox = SubNetboxSerializer()
     to_interface = SubInterfaceSerializer()

python/nav/web/api/v1/urls.py

@@ -52,6 +52,7 @@
     basename='unrecognized-neighbor',
 )
 router.register(r'auditlog', auditlogapi.LogEntryViewSet, basename='auditlog')
+router.register(r'module', views.ModuleViewSet, basename='module')
 
 
 urlpatterns = [

python/nav/web/api/v1/views.py

@@ -154,6 +154,7 @@ def get_endpoints(request=None, version=1):
         ),
         'vlan': reverse_lazy('{}vlan-list'.format(prefix), **kwargs),
         'rack': reverse_lazy('{}rack-list'.format(prefix), **kwargs),
+        'module': reverse_lazy('{}module-list'.format(prefix), **kwargs),
     }
 
 
@@ -1081,3 +1082,23 @@ def get_nav_version(request):
     :type request: django.http.HttpRequest
     """
     return JsonResponse({"version": VERSION})
+
+
+class ModuleViewSet(NAVAPIMixin, viewsets.ReadOnlyModelViewSet):
+    """Lists all modules.
+
+    Filters
+    -------
+    - netbox
+    - device__serial
+
+    Example: `/api/1/module/?netbox=91&device__serial=AB12345`
+    """
+
+    queryset = manage.Module.objects.all()
+    filter_backends = NAVAPIMixin.filter_backends
+    filterset_fields = (
+        'netbox',
+        'device__serial',
+    )
+    serializer_class = serializers.ModuleSerializer