feat(itim): Add Port API v2 endpoint

ref: #248 #356

app/itim/models/services.py

@@ -23,9 +23,9 @@ class Port(TenancyObject):
             'protocol',
         ]
 
-        verbose_name = "Protocol"
+        verbose_name = "Port"
 
-        verbose_name_plural = "Protocols"
+        verbose_name_plural = "Ports"
 
 
     class Protocol(models.TextChoices):

app/itim/serializers/port.py

@@ -0,0 +1,97 @@
+from rest_framework.reverse import reverse
+from rest_framework import serializers
+
+from access.serializers.organization import OrganizationBaseSerializer
+
+from itam.serializers.device import DeviceBaseSerializer
+
+from itim.models.services import Port
+
+
+
+class PortBaseSerializer(serializers.ModelSerializer):
+
+    display_name = serializers.SerializerMethodField('get_display_name')
+
+    def get_display_name(self, item):
+
+        return str( item )
+
+    url = serializers.HyperlinkedIdentityField(
+        view_name="API:_api_v2_port-detail", format="html"
+    )
+
+    name = serializers.SerializerMethodField('get_display_name')
+
+    class Meta:
+
+        model = Port
+
+        fields = [
+            'id',
+            'display_name',
+            'name',
+            'url',
+        ]
+
+        read_only_fields = [
+            'id',
+            'display_name',
+            'name',
+            'url',
+        ]
+
+
+
+class PortModelSerializer(PortBaseSerializer):
+
+    _urls = serializers.SerializerMethodField('get_url')
+
+    def get_url(self, item):
+
+        return {
+            '_self': reverse("API:_api_v2_port-detail", request=self._context['view'].request, kwargs={'pk': item.pk}),
+            'history': reverse(
+                "API:_api_v2_model_history-list",
+                request=self._context['view'].request,
+                kwargs={
+                    'model_class': self.Meta.model._meta.model_name,
+                    'model_id': item.pk
+                }
+            ),
+            'notes': reverse("API:_api_v2_port_notes-list", request=self._context['view'].request, kwargs={'port_id': item.pk}),
+        }
+
+
+    class Meta:
+
+        model = Port
+
+        fields =  [
+             'id',
+            'organization',
+            'name',
+            'model_notes',
+            'number',
+            'description',
+            'protocol',
+            'is_global',
+            'created',
+            'modified',
+            '_urls',
+        ]
+
+        read_only_fields = [
+            'id',
+            'display_name',
+            'name',
+            'created',
+            'modified',
+            '_urls',
+        ]
+
+
+
+class PortViewSerializer(PortModelSerializer):
+
+    organization = OrganizationBaseSerializer( many = False, read_only = True )

app/itim/viewsets/port.py

@@ -0,0 +1,84 @@
+from drf_spectacular.utils import extend_schema, extend_schema_view, OpenApiResponse
+
+from api.viewsets.common import ModelViewSet
+
+from itim.serializers.port import (
+    Port,
+    PortModelSerializer,
+    PortViewSerializer
+)
+
+
+
+@extend_schema_view(
+    create=extend_schema(
+        summary = 'Create a port',
+        description='',
+        responses = {
+            201: OpenApiResponse(description='Device created', response=PortViewSerializer),
+            400: OpenApiResponse(description='Validation failed.'),
+            403: OpenApiResponse(description='User is missing create permissions'),
+        }
+    ),
+    destroy = extend_schema(
+        summary = 'Delete a port',
+        description = '',
+        responses = {
+            204: OpenApiResponse(description=''),
+            403: OpenApiResponse(description='User is missing delete permissions'),
+        }
+    ),
+    list = extend_schema(
+        summary = 'Fetch all ports',
+        description='',
+        responses = {
+            200: OpenApiResponse(description='', response=PortViewSerializer),
+            403: OpenApiResponse(description='User is missing view permissions'),
+        }
+    ),
+    retrieve = extend_schema(
+        summary = 'Fetch a single port',
+        description='',
+        responses = {
+            200: OpenApiResponse(description='', response=PortViewSerializer),
+            403: OpenApiResponse(description='User is missing view permissions'),
+        }
+    ),
+    update = extend_schema(exclude = True),
+    partial_update = extend_schema(
+        summary = 'Update a port',
+        description = '',
+        responses = {
+            200: OpenApiResponse(description='', response=PortViewSerializer),
+            403: OpenApiResponse(description='User is missing change permissions'),
+        }
+    ),
+)
+class ViewSet( ModelViewSet ):
+
+    filterset_fields = [
+        'number',
+        'protocol',
+    ]
+
+    search_fields = [
+        'description',
+    ]
+
+    model = Port
+
+    documentation: str = 'https://nofusscomputing.com/docs/not_model_docs'
+
+    view_description = 'Physical Devices'
+
+    def get_serializer_class(self):
+
+        if (
+            self.action == 'list'
+            or self.action == 'retrieve'
+        ):
+
+            return globals()[str( self.model._meta.verbose_name) + 'ViewSerializer']
+
+
+        return globals()[str( self.model._meta.verbose_name) + 'ModelSerializer']