Swagger issue fixes from the Ericsson team

[modeling/etsicatalog.git] / catalog / packages / views / vnf_package_views.py

diff --git a/catalog/packages/views/vnf_package_views.py b/catalog/packages/views/vnf_package_views.py
index 76891f2..5fca931 100644 (file)
--- a/catalog/packages/views/vnf_package_views.py
+++ b/catalog/packages/views/vnf_package_views.py
@@ -16,18 +16,20 @@ import logging
 
 from django.http import StreamingHttpResponse
 from drf_yasg.utils import swagger_auto_schema, no_body
+from drf_yasg import openapi
 from rest_framework import status
 from rest_framework.decorators import api_view
 from rest_framework.response import Response
 
-from catalog.packages.serializers.upload_vnf_pkg_from_uri_req import UploadVnfPackageFromUriRequestSerializer
-from catalog.packages.serializers.create_vnf_pkg_info_req import CreateVnfPkgInfoRequestSerializer
-from catalog.packages.serializers.vnf_pkg_info import VnfPkgInfoSerializer
-from catalog.packages.serializers.vnf_pkg_infos import VnfPkgInfosSerializer
 from catalog.packages.biz.vnf_package import VnfPackage
 from catalog.packages.biz.vnf_package import VnfPkgUploadThread
-from catalog.packages.biz.vnf_package import parse_vnfd_and_save
 from catalog.packages.biz.vnf_package import handle_upload_failed
+from catalog.packages.biz.vnf_package import parse_vnfd_and_save
+from catalog.packages.const import TAG_VNF_PACKAGE_API
+from catalog.packages.serializers.create_vnf_pkg_info_req import CreateVnfPkgInfoRequestSerializer
+from catalog.packages.serializers.upload_vnf_pkg_from_uri_req import UploadVnfPackageFromUriRequestSerializer
+from catalog.packages.serializers.vnf_pkg_info import VnfPkgInfoSerializer
+from catalog.packages.serializers.vnf_pkg_infos import VnfPkgInfosSerializer
 from .common import validate_data
 from .common import view_safe_call_with_log
 
@@ -37,7 +39,7 @@ logger = logging.getLogger(__name__)
 @swagger_auto_schema(
     method="GET",
     operation_description="Query multiple VNF package resource",
-    tags=["VNF Package API"],
+    tags=[TAG_VNF_PACKAGE_API],
     request_body=no_body,
     responses={
         status.HTTP_200_OK: VnfPkgInfosSerializer(),
@@ -47,7 +49,7 @@ logger = logging.getLogger(__name__)
 @swagger_auto_schema(
     method="POST",
     operation_description="Create an individual VNF package resource",
-    tags=["VNF Package API"],
+    tags=[TAG_VNF_PACKAGE_API],
     request_body=CreateVnfPkgInfoRequestSerializer,
     responses={
         status.HTTP_201_CREATED: VnfPkgInfoSerializer(),
@@ -75,13 +77,17 @@ def vnf_packages_rc(request):
 @swagger_auto_schema(
     method="GET",
     operation_description="Read VNFD of an on-boarded VNF package",
-    tags=["VNF Package API"],
+    tags=[TAG_VNF_PACKAGE_API],
     request_body=no_body,
     responses={
-        status.HTTP_200_OK: VnfPkgInfosSerializer(),
+        status.HTTP_200_OK: openapi.Response('VNFD of an on-boarded VNF package',
+                                             schema=openapi.Schema(format=openapi.FORMAT_BINARY,
+                                                                   type=openapi.TYPE_STRING)),
         status.HTTP_404_NOT_FOUND: "VNF package does not exist",
         status.HTTP_500_INTERNAL_SERVER_ERROR: "Internal error"
-    }
+    },
+    produces='application/octet-stream',
+    operation_id='VNFD of an on-boarded VNF package'
 )
 @api_view(http_method_names=["GET"])
 @view_safe_call_with_log(logger=logger)
@@ -99,7 +105,7 @@ def vnfd_rd(request, **kwargs):
 @swagger_auto_schema(
     method='PUT',
     operation_description="Upload VNF package content",
-    tags=["VNF Package API"],
+    tags=[TAG_VNF_PACKAGE_API],
     request_body=no_body,
     responses={
         status.HTTP_202_ACCEPTED: "Successfully",
@@ -109,10 +115,12 @@ def vnfd_rd(request, **kwargs):
 @swagger_auto_schema(
     method="GET",
     operation_description="Fetch VNF package content",
-    tags=["VNF Package API"],
+    tags=[TAG_VNF_PACKAGE_API],
     request_body=no_body,
     responses={
-        status.HTTP_200_OK: VnfPkgInfosSerializer(),
+        status.HTTP_200_OK: openapi.Response('VNF package file',
+                                             schema=openapi.Schema(format=openapi.FORMAT_BINARY,
+                                                                   type=openapi.TYPE_STRING)),
         status.HTTP_404_NOT_FOUND: "VNF package does not exist",
         status.HTTP_500_INTERNAL_SERVER_ERROR: "Internal error"
     }
@@ -141,7 +149,7 @@ def package_content_ru(request, **kwargs):
 @swagger_auto_schema(
     method='POST',
     operation_description="Upload VNF package content from uri",
-    tags=["VNF Package API"],
+    tags=[TAG_VNF_PACKAGE_API],
     request_body=UploadVnfPackageFromUriRequestSerializer,
     responses={
         status.HTTP_202_ACCEPTED: "Successfully",
@@ -165,7 +173,7 @@ def upload_from_uri_c(request, **kwargs):
 @swagger_auto_schema(
     method='GET',
     operation_description="Query an individual VNF package resource",
-    tags=["VNF Package API"],
+    tags=[TAG_VNF_PACKAGE_API],
     request_body=no_body,
     responses={
         status.HTTP_200_OK: VnfPkgInfoSerializer(),
@@ -176,7 +184,7 @@ def upload_from_uri_c(request, **kwargs):
 @swagger_auto_schema(
     method='DELETE',
     operation_description="Delete an individual VNF package resource",
-    tags=["VNF Package API"],
+    tags=[TAG_VNF_PACKAGE_API],
     request_body=no_body,
     responses={
         status.HTTP_204_NO_CONTENT: "No content",