Initial work on API v2.0

netbox/dcim/api/urls.py

@@ -9,52 +9,50 @@ from .views import *
 urlpatterns = [
 
     # Sites
-    url(r'^sites/$', SiteListView.as_view(), name='site_list'),
-    url(r'^sites/(?P<pk>\d+)/$', SiteDetailView.as_view(), name='site_detail'),
+    url(r'^sites/$', SiteViewSet.as_view({'get': 'list'}), name='site_list'),
+    url(r'^sites/(?P<pk>\d+)/$', SiteViewSet.as_view({'get': 'retrieve'}), name='site_detail'),
     url(r'^sites/(?P<pk>\d+)/graphs/$', GraphListView.as_view(), {'type': GRAPH_TYPE_SITE}, name='site_graphs'),
-    url(r'^sites/(?P<site>\d+)/racks/$', RackListView.as_view(), name='site_racks'),
 
     # Rack groups
-    url(r'^rack-groups/$', RackGroupListView.as_view(), name='rackgroup_list'),
-    url(r'^rack-groups/(?P<pk>\d+)/$', RackGroupDetailView.as_view(), name='rackgroup_detail'),
+    url(r'^rack-groups/$', RackGroupViewSet.as_view({'get': 'list'}), name='rackgroup_list'),
+    url(r'^rack-groups/(?P<pk>\d+)/$', RackGroupViewSet.as_view({'get': 'retrieve'}), name='rackgroup_detail'),
 
     # Rack roles
-    url(r'^rack-roles/$', RackRoleListView.as_view(), name='rackrole_list'),
-    url(r'^rack-roles/(?P<pk>\d+)/$', RackRoleDetailView.as_view(), name='rackrole_detail'),
+    url(r'^rack-roles/$', RackRoleViewSet.as_view({'get': 'list'}), name='rackrole_list'),
+    url(r'^rack-roles/(?P<pk>\d+)/$', RackRoleViewSet.as_view({'get': 'retrieve'}), name='rackrole_detail'),
 
     # Racks
-    url(r'^racks/$', RackListView.as_view(), name='rack_list'),
-    url(r'^racks/(?P<pk>\d+)/$', RackDetailView.as_view(), name='rack_detail'),
+    url(r'^racks/$', RackViewSet.as_view({'get': 'list'}), name='rack_list'),
+    url(r'^racks/(?P<pk>\d+)/$', RackViewSet.as_view({'get': 'retrieve'}), name='rack_detail'),
     url(r'^racks/(?P<pk>\d+)/rack-units/$', RackUnitListView.as_view(), name='rack_units'),
 
     # Manufacturers
-    url(r'^manufacturers/$', ManufacturerListView.as_view(), name='manufacturer_list'),
-    url(r'^manufacturers/(?P<pk>\d+)/$', ManufacturerDetailView.as_view(), name='manufacturer_detail'),
+    url(r'^manufacturers/$', ManufacturerViewSet.as_view({'get': 'list'}), name='manufacturer_list'),
+    url(r'^manufacturers/(?P<pk>\d+)/$', ManufacturerViewSet.as_view({'get': 'retrieve'}), name='manufacturer_detail'),
 
     # Device types
-    url(r'^device-types/$', DeviceTypeListView.as_view(), name='devicetype_list'),
-    url(r'^device-types/(?P<pk>\d+)/$', DeviceTypeDetailView.as_view(), name='devicetype_detail'),
+    url(r'^device-types/$', DeviceTypeViewSet.as_view({'get': 'list'}), name='devicetype_list'),
+    url(r'^device-types/(?P<pk>\d+)/$', DeviceTypeViewSet.as_view({'get': 'retrieve'}), name='devicetype_detail'),
 
     # Device roles
-    url(r'^device-roles/$', DeviceRoleListView.as_view(), name='devicerole_list'),
-    url(r'^device-roles/(?P<pk>\d+)/$', DeviceRoleDetailView.as_view(), name='devicerole_detail'),
+    url(r'^device-roles/$', DeviceRoleViewSet.as_view({'get': 'list'}), name='devicerole_list'),
+    url(r'^device-roles/(?P<pk>\d+)/$', DeviceRoleViewSet.as_view({'get': 'retrieve'}), name='devicerole_detail'),
 
     # Platforms
-    url(r'^platforms/$', PlatformListView.as_view(), name='platform_list'),
-    url(r'^platforms/(?P<pk>\d+)/$', PlatformDetailView.as_view(), name='platform_detail'),
+    url(r'^platforms/$', PlatformViewSet.as_view({'get': 'list'}), name='platform_list'),
+    url(r'^platforms/(?P<pk>\d+)/$', PlatformViewSet.as_view({'get': 'retrieve'}), name='platform_detail'),
 
     # Devices
-    url(r'^devices/$', DeviceListView.as_view(), name='device_list'),
-    url(r'^devices/(?P<pk>\d+)/$', DeviceDetailView.as_view(), name='device_detail'),
+    url(r'^devices/$', DeviceViewSet.as_view({'get': 'list'}), name='device_list'),
+    url(r'^devices/(?P<pk>\d+)/$', DeviceViewSet.as_view({'get': 'retrieve'}), name='device_detail'),
     url(r'^devices/(?P<pk>\d+)/lldp-neighbors/$', LLDPNeighborsView.as_view(), name='device_lldp-neighbors'),
-    url(r'^devices/(?P<pk>\d+)/console-ports/$', ConsolePortListView.as_view(), name='device_consoleports'),
-    url(r'^devices/(?P<pk>\d+)/console-server-ports/$', ConsoleServerPortListView.as_view(),
-        name='device_consoleserverports'),
-    url(r'^devices/(?P<pk>\d+)/power-ports/$', PowerPortListView.as_view(), name='device_powerports'),
-    url(r'^devices/(?P<pk>\d+)/power-outlets/$', PowerOutletListView.as_view(), name='device_poweroutlets'),
-    url(r'^devices/(?P<pk>\d+)/interfaces/$', InterfaceListView.as_view(), name='device_interfaces'),
-    url(r'^devices/(?P<pk>\d+)/device-bays/$', DeviceBayListView.as_view(), name='device_devicebays'),
-    url(r'^devices/(?P<pk>\d+)/modules/$', ModuleListView.as_view(), name='device_modules'),
+    url(r'^devices/(?P<pk>\d+)/console-ports/$', ConsolePortViewSet.as_view({'get': 'list'}), name='device_consoleports'),
+    url(r'^devices/(?P<pk>\d+)/console-server-ports/$', ConsoleServerPortViewSet.as_view({'get': 'list'}), name='device_consoleserverports'),
+    url(r'^devices/(?P<pk>\d+)/power-ports/$', PowerPortViewSet.as_view({'get': 'list'}), name='device_powerports'),
+    url(r'^devices/(?P<pk>\d+)/power-outlets/$', PowerOutletViewSet.as_view({'get': 'list'}), name='device_poweroutlets'),
+    url(r'^devices/(?P<pk>\d+)/interfaces/$', InterfaceViewSet.as_view({'get': 'list'}), name='device_interfaces'),
+    url(r'^devices/(?P<pk>\d+)/device-bays/$', DeviceBayViewSet.as_view({'get': 'list'}), name='device_devicebays'),
+    url(r'^devices/(?P<pk>\d+)/modules/$', ModuleViewSet.as_view({'get': 'list'}), name='device_modules'),
 
     # Console ports
     url(r'^console-ports/(?P<pk>\d+)/$', ConsolePortView.as_view(), name='consoleport'),

netbox/dcim/api/views.py

@@ -3,10 +3,10 @@ from rest_framework.permissions import DjangoModelPermissionsOrAnonReadOnly
 from rest_framework.response import Response
 from rest_framework.settings import api_settings
 from rest_framework.views import APIView
+from rest_framework.viewsets import ModelViewSet
 
 from django.conf import settings
 from django.contrib.contenttypes.models import ContentType
-from django.db.models import Count
 from django.http import Http404
 from django.shortcuts import get_object_or_404
 
@@ -15,7 +15,7 @@ from dcim.models import (
     InterfaceConnection, Manufacturer, Module, Platform, PowerOutlet, PowerPort, Rack, RackGroup, RackRole, Site,
 )
 from dcim import filters
-from extras.api.views import CustomFieldModelAPIView
+from extras.api.views import CustomFieldModelViewSet
 from extras.api.renderers import BINDZoneRenderer, FlatJSONRenderer
 from utilities.api import ServiceUnavailable
 from .exceptions import MissingFilterException
@@ -26,19 +26,11 @@ from . import serializers
 # Sites
 #
 
-class SiteListView(CustomFieldModelAPIView, generics.ListAPIView):
+class SiteViewSet(CustomFieldModelViewSet):
     """
-    List all sites
+    List and retrieve sites
     """
-    queryset = Site.objects.select_related('tenant').prefetch_related('custom_field_values__field')
-    serializer_class = serializers.SiteSerializer
-
-
-class SiteDetailView(CustomFieldModelAPIView, generics.RetrieveAPIView):
-    """
-    Retrieve a single site
-    """
-    queryset = Site.objects.select_related('tenant').prefetch_related('custom_field_values__field')
+    queryset = Site.objects.select_related('tenant')
     serializer_class = serializers.SiteSerializer
 
 
@@ -46,38 +38,22 @@ class SiteDetailView(CustomFieldModelAPIView, generics.RetrieveAPIView):
 # Rack groups
 #
 
-class RackGroupListView(generics.ListAPIView):
+class RackGroupViewSet(ModelViewSet):
     """
-    List all rack groups
+    List and retrieve rack groups
     """
     queryset = RackGroup.objects.select_related('site')
     serializer_class = serializers.RackGroupSerializer
     filter_class = filters.RackGroupFilter
 
 
-class RackGroupDetailView(generics.RetrieveAPIView):
-    """
-    Retrieve a single rack group
-    """
-    queryset = RackGroup.objects.select_related('site')
-    serializer_class = serializers.RackGroupSerializer
-
-
 #
 # Rack roles
 #
 
-class RackRoleListView(generics.ListAPIView):
+class RackRoleViewSet(ModelViewSet):
     """
-    List all rack roles
-    """
-    queryset = RackRole.objects.all()
-    serializer_class = serializers.RackRoleSerializer
-
-
-class RackRoleDetailView(generics.RetrieveAPIView):
-    """
-    Retrieve a single rack role
+    List and retrieve rack roles
     """
     queryset = RackRole.objects.all()
     serializer_class = serializers.RackRoleSerializer
@@ -87,28 +63,18 @@ class RackRoleDetailView(generics.RetrieveAPIView):
 # Racks
 #
 
-class RackListView(CustomFieldModelAPIView, generics.ListAPIView):
+class RackViewSet(CustomFieldModelViewSet):
     """
-    List racks (filterable)
+    List and retrieve racks
     """
-    queryset = Rack.objects.select_related('site', 'group__site', 'tenant')\
-        .prefetch_related('custom_field_values__field')
-    serializer_class = serializers.RackSerializer
+    queryset = Rack.objects.select_related('site', 'group__site', 'tenant')
     filter_class = filters.RackFilter
 
+    def get_serializer_class(self):
+        if self.action == 'retrieve':
+            return serializers.RackDetailSerializer
+        return serializers.RackSerializer
 
-class RackDetailView(CustomFieldModelAPIView, generics.RetrieveAPIView):
-    """
-    Retrieve a single rack
-    """
-    queryset = Rack.objects.select_related('site', 'group__site', 'tenant')\
-        .prefetch_related('custom_field_values__field')
-    serializer_class = serializers.RackDetailSerializer
-
-
-#
-# Rack units
-#
 
 class RackUnitListView(APIView):
     """
@@ -139,17 +105,9 @@ class RackUnitListView(APIView):
 # Manufacturers
 #
 
-class ManufacturerListView(generics.ListAPIView):
+class ManufacturerViewSet(ModelViewSet):
     """
-    List all hardware manufacturers
-    """
-    queryset = Manufacturer.objects.all()
-    serializer_class = serializers.ManufacturerSerializer
-
-
-class ManufacturerDetailView(generics.RetrieveAPIView):
-    """
-    Retrieve a single hardware manufacturers
+    List and retrieve manufacturers
     """
     queryset = Manufacturer.objects.all()
     serializer_class = serializers.ManufacturerSerializer
@@ -159,38 +117,26 @@ class ManufacturerDetailView(generics.RetrieveAPIView):
 # Device Types
 #
 
-class DeviceTypeListView(CustomFieldModelAPIView, generics.ListAPIView):
+class DeviceTypeViewSet(CustomFieldModelViewSet):
     """
-    List device types (filterable)
+    List and retrieve device types
     """
-    queryset = DeviceType.objects.select_related('manufacturer').prefetch_related('custom_field_values__field')
-    serializer_class = serializers.DeviceTypeSerializer
+    queryset = DeviceType.objects.select_related('manufacturer')
     filter_class = filters.DeviceTypeFilter
 
-
-class DeviceTypeDetailView(CustomFieldModelAPIView, generics.RetrieveAPIView):
-    """
-    Retrieve a single device type
-    """
-    queryset = DeviceType.objects.select_related('manufacturer').prefetch_related('custom_field_values__field')
-    serializer_class = serializers.DeviceTypeDetailSerializer
+    def get_serializer_class(self):
+        if self.action == 'retrieve':
+            return serializers.DeviceTypeDetailSerializer
+        return serializers.DeviceTypeSerializer
 
 
 #
 # Device roles
 #
 
-class DeviceRoleListView(generics.ListAPIView):
+class DeviceRoleViewSet(ModelViewSet):
     """
-    List all device roles
-    """
-    queryset = DeviceRole.objects.all()
-    serializer_class = serializers.DeviceRoleSerializer
-
-
-class DeviceRoleDetailView(generics.RetrieveAPIView):
-    """
-    Retrieve a single device role
+    List and retrieve device roles
     """
     queryset = DeviceRole.objects.all()
     serializer_class = serializers.DeviceRoleSerializer
@@ -200,17 +146,9 @@ class DeviceRoleDetailView(generics.RetrieveAPIView):
 # Platforms
 #
 
-class PlatformListView(generics.ListAPIView):
+class PlatformViewSet(ModelViewSet):
     """
-    List all platforms
-    """
-    queryset = Platform.objects.all()
-    serializer_class = serializers.PlatformSerializer
-
-
-class PlatformDetailView(generics.RetrieveAPIView):
-    """
-    Retrieve a single platform
+    List and retrieve platforms
     """
     queryset = Platform.objects.all()
     serializer_class = serializers.PlatformSerializer
@@ -220,40 +158,31 @@ class PlatformDetailView(generics.RetrieveAPIView):
 # Devices
 #
 
-class DeviceListView(CustomFieldModelAPIView, generics.ListAPIView):
+class DeviceViewSet(CustomFieldModelViewSet):
     """
-    List devices (filterable)
+    List and retrieve devices
     """
-    queryset = Device.objects.select_related('device_type__manufacturer', 'device_role', 'tenant', 'platform',
-                                             'rack__site', 'parent_bay').prefetch_related('primary_ip4__nat_outside',
-                                                                                          'primary_ip6__nat_outside',
-                                                                                          'custom_field_values__field')
+    queryset = Device.objects.select_related(
+        'device_type__manufacturer', 'device_role', 'tenant', 'platform', 'rack__site', 'parent_bay',
+    ).prefetch_related(
+        'primary_ip4__nat_outside', 'primary_ip6__nat_outside',
+    )
     serializer_class = serializers.DeviceSerializer
     filter_class = filters.DeviceFilter
     renderer_classes = api_settings.DEFAULT_RENDERER_CLASSES + [BINDZoneRenderer, FlatJSONRenderer]
 
 
-class DeviceDetailView(CustomFieldModelAPIView, generics.RetrieveAPIView):
-    """
-    Retrieve a single device
-    """
-    queryset = Device.objects.select_related('device_type__manufacturer', 'device_role', 'tenant', 'platform',
-                                             'rack__site', 'parent_bay').prefetch_related('custom_field_values__field')
-    serializer_class = serializers.DeviceSerializer
-
-
 #
 # Console ports
 #
 
-class ConsolePortListView(generics.ListAPIView):
+class ConsolePortViewSet(ModelViewSet):
     """
-    List console ports (by device)
+    List and retrieve console ports (by device)
     """
     serializer_class = serializers.ConsolePortSerializer
 
     def get_queryset(self):
-
         device = get_object_or_404(Device, pk=self.kwargs['pk'])
         return ConsolePort.objects.filter(device=device).select_related('cs_port')
 
@@ -268,14 +197,13 @@ class ConsolePortView(generics.RetrieveUpdateDestroyAPIView):
 # Console server ports
 #
 
-class ConsoleServerPortListView(generics.ListAPIView):
+class ConsoleServerPortViewSet(ModelViewSet):
     """
-    List console server ports (by device)
+    List and retrieve console server ports (by device)
     """
     serializer_class = serializers.ConsoleServerPortSerializer
 
     def get_queryset(self):
-
         device = get_object_or_404(Device, pk=self.kwargs['pk'])
         return ConsoleServerPort.objects.filter(device=device).select_related('connected_console')
 
@@ -284,14 +212,13 @@ class ConsoleServerPortListView(generics.ListAPIView):
 # Power ports
 #
 
-class PowerPortListView(generics.ListAPIView):
+class PowerPortViewSet(ModelViewSet):
     """
-    List power ports (by device)
+    List and retrieve power ports (by device)
     """
     serializer_class = serializers.PowerPortSerializer
 
     def get_queryset(self):
-
         device = get_object_or_404(Device, pk=self.kwargs['pk'])
         return PowerPort.objects.filter(device=device).select_related('power_outlet')
 
@@ -306,14 +233,13 @@ class PowerPortView(generics.RetrieveUpdateDestroyAPIView):
 # Power outlets
 #
 
-class PowerOutletListView(generics.ListAPIView):
+class PowerOutletViewSet(ModelViewSet):
     """
-    List power outlets (by device)
+    List and retrieve power outlets (by device)
     """
     serializer_class = serializers.PowerOutletSerializer
 
     def get_queryset(self):
-
         device = get_object_or_404(Device, pk=self.kwargs['pk'])
         return PowerOutlet.objects.filter(device=device).select_related('connected_port')
 
@@ -322,9 +248,9 @@ class PowerOutletListView(generics.ListAPIView):
 # Interfaces
 #
 
-class InterfaceListView(generics.ListAPIView):
+class InterfaceViewSet(ModelViewSet):
     """
-    List interfaces (by device)
+    List and retrieve interfaces (by device)
     """
     serializer_class = serializers.InterfaceSerializer
     filter_class = filters.InterfaceFilter
@@ -372,14 +298,13 @@ class InterfaceConnectionListView(generics.ListAPIView):
 # Device bays
 #
 
-class DeviceBayListView(generics.ListAPIView):
+class DeviceBayViewSet(ModelViewSet):
     """
-    List device bays (by device)
+    List and retrieve device bays (by device)
     """
     serializer_class = serializers.DeviceBayNestedSerializer
 
     def get_queryset(self):
-
         device = get_object_or_404(Device, pk=self.kwargs['pk'])
         return DeviceBay.objects.filter(device=device).select_related('installed_device')
 
@@ -388,14 +313,13 @@ class DeviceBayListView(generics.ListAPIView):
 # Modules
 #
 
-class ModuleListView(generics.ListAPIView):
+class ModuleViewSet(ModelViewSet):
     """
-    List device modules (by device)
+    List and retrieve modules (by device)
     """
     serializer_class = serializers.ModuleSerializer
 
     def get_queryset(self):
-
         device = get_object_or_404(Device, pk=self.kwargs['pk'])
         return Module.objects.filter(device=device).select_related('device', 'manufacturer')
 
@@ -442,8 +366,19 @@ class RelatedConnectionsView(APIView):
         super(RelatedConnectionsView, self).__init__()
 
         # Custom fields
-        self.content_type = ContentType.objects.get_for_model(Device)
-        self.custom_fields = self.content_type.custom_fields.prefetch_related('choices')
+        content_type = ContentType.objects.get_for_model(Device)
+        custom_fields = content_type.custom_fields.prefetch_related('choices')
+
+        # Cache all relevant CustomFieldChoices. This saves us from having to do a lookup per select field per object.
+        custom_field_choices = {}
+        for field in custom_fields:
+            for cfc in field.choices.all():
+                custom_field_choices[cfc.id] = cfc.value
+
+        self.context = {
+            'custom_fields': custom_fields,
+            'custom_field_choices': custom_field_choices,
+        }
 
     def get(self, request):
 
@@ -469,7 +404,7 @@ class RelatedConnectionsView(APIView):
 
         # Initialize response skeleton
         response = {
-            'device': serializers.DeviceSerializer(device, context={'view': self}).data,
+            'device': serializers.DeviceSerializer(device, context=self.context).data,
             'console-ports': [],
             'power-ports': [],
             'interfaces': [],

netbox/dcim/tests/test_apis.py

@@ -82,21 +82,6 @@ class SiteTest(APITestCase):
             sorted(self.standard_fields),
         )
 
-    def test_get_site_list_rack(self, endpoint='/{}api/dcim/sites/1/racks/'.format(settings.BASE_PATH)):
-        response = self.client.get(endpoint)
-        content = json.loads(response.content.decode('utf-8'))
-        self.assertEqual(response.status_code, status.HTTP_200_OK)
-        for i in json.loads(response.content.decode('utf-8')):
-            self.assertEqual(
-                sorted(i.keys()),
-                sorted(self.rack_fields),
-            )
-            # Check Nested Serializer.
-            self.assertEqual(
-                sorted(i.get('site').keys()),
-                sorted(self.nested_fields),
-            )
-
     def test_get_site_list_graphs(self, endpoint='/{}api/dcim/sites/1/graphs/'.format(settings.BASE_PATH)):
         response = self.client.get(endpoint)
         content = json.loads(response.content.decode('utf-8'))
@@ -239,6 +224,7 @@ class DeviceTypeTest(APITestCase):
         'subdevice_role',
         'comments',
         'custom_fields',
+        'instance_count',
     ]
 
     nested_fields = [