feat(itim): Add Port API v2 endpoint

ref: #248 #356
2024-10-21 15:43:28 +09:30
parent 06362f226c
commit cfedd4b74e
5 changed files with 191 additions and 2 deletions
--- a/app/itim/viewsets/port.py
+++ b/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']