Merge remote-tracking branch 'origin/main'

protocol_version_manage/views.py

@@ -10,6 +10,8 @@ from rest_framework.response import Response
 from rest_framework import status
 from rest_framework.viewsets import GenericViewSet
 from rest_framework.mixins import ListModelMixin
+from drf_yasg.utils import swagger_auto_schema
+from drf_yasg import openapi
 from .models import (AllDevCmdDefineAndVersion, AllProtocolDefinAndVersion, 
                      AllProtocolVersion, CurrentDevVersion)
 from .serializers import (AllDevCmdDefineAndVersionSerializer, AllProtocolDefinAndVersionSerializer,
@@ -18,6 +20,12 @@ from .services import (init_protocol_version_manage, update_device_protocol_and_
                        add_protocol_version_manage, update_protocol_version_manage)
 
 
+@swagger_auto_schema(methods=['POST'], request_body=openapi.Schema(
+    type=openapi.TYPE_OBJECT,
+    properties={
+        'protocol_name': openapi.Schema(type=openapi.TYPE_STRING),
+    }
+))
 @api_view(['POST'])
 def init(request):
     """
@@ -46,6 +54,13 @@ def init(request):
     return Response(data=res_data, status=status.HTTP_200_OK)
 
 
+@swagger_auto_schema(methods=['POST'], request_body=openapi.Schema(
+    type=openapi.TYPE_OBJECT,
+    properties={
+        'version': openapi.Schema(type=openapi.TYPE_STRING),
+        'protocol_name': openapi.Schema(type=openapi.TYPE_STRING),
+    }
+))
 @api_view(['POST'])
 def change_protocol_version(request):
     version = request.data.get('version')
@@ -56,6 +71,16 @@ def change_protocol_version(request):
     return update_device_protocol_and_cmds(protocol_name, version)
     
 
+@swagger_auto_schema(methods=['POST'], request_body=openapi.Schema(
+    type=openapi.TYPE_OBJECT,
+    properties={
+        'version': openapi.Schema(type=openapi.TYPE_STRING),
+        'protocol_name': openapi.Schema(type=openapi.TYPE_STRING),
+        'cmds': openapi.Schema(type=openapi.TYPE_ARRAY, items=openapi.Schema(type=openapi.TYPE_OBJECT, properties={
+            'context': openapi.Schema(type=openapi.TYPE_STRING, default='内容为 AllProtocolDefinAndVersionSerializer 的内容'),
+        }))
+    }
+))
 @api_view(['POST'])
 def add_protocol_version(request):
     version = request.data.get('version')
@@ -68,6 +93,16 @@ def add_protocol_version(request):
     return add_protocol_version_manage(protocol_name, version, cmds)
 
 
+@swagger_auto_schema(methods=['POST'], request_body=openapi.Schema(
+    type=openapi.TYPE_OBJECT,
+    properties={
+        'version': openapi.Schema(type=openapi.TYPE_STRING),
+        'protocol_name': openapi.Schema(type=openapi.TYPE_STRING),
+        'cmds': openapi.Schema(type=openapi.TYPE_ARRAY, items=openapi.Schema(type=openapi.TYPE_OBJECT, properties={
+            'context': openapi.Schema(type=openapi.TYPE_STRING, default='内容为 AllProtocolDefinAndVersionSerializer 的内容'),
+        }))
+    }
+))
 @api_view(['POST'])
 def update_protocol_version(request):
     version = request.data.get('version')
@@ -85,6 +120,14 @@ class AllProtocolVersionViewSet(GenericViewSet, ListModelMixin):
     serializer_class = AllProtocolVersionSerializer
 
 
+# @swagger_auto_schema(methods=['POST'], request_body=openapi.Schema(
+#     type=openapi.TYPE_OBJECT,
+#     properties={
+#         'file': openapi.Schema(type=openapi.TYPE_FILE),
+#         'protocol_name': openapi.Schema(type=openapi.TYPE_STRING),
+#         'version': openapi.Schema(type=openapi.TYPE_STRING)
+#     }
+# ))
 @api_view(['POST'])
 @parser_classes([MultiPartParser])
 def raw_file_upload(request):
@@ -130,6 +173,7 @@ def raw_file_upload(request):
     return Response(data={'path': file_path}, status=status.HTTP_200_OK)
 
 
+# @swagger_auto_schema(methods=['GET'])
 @api_view(['GET'])
 @parser_classes([MultiPartParser])
 def raw_file_download(request, protocol_name, version):