Add log and comment

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

diff --git a/catalog/packages/views/nsdm_subscription_views.py b/catalog/packages/views/nsdm_subscription_views.py
index b4b82ae..e368466 100644 (file)
--- a/catalog/packages/views/nsdm_subscription_views.py
+++ b/catalog/packages/views/nsdm_subscription_views.py
@@ -19,15 +19,15 @@ from rest_framework import status
 from rest_framework.decorators import api_view
 from rest_framework.response import Response
 
+from catalog.packages.biz.nsdm_subscription import NsdmSubscription
+from catalog.packages.const import TAG_NSD_API
 from catalog.packages.serializers.nsdm_filter_data import NsdmNotificationsFilter
-from catalog.packages.serializers.nsdm_subscription import NsdmSubscriptionsSerializer
 from catalog.packages.serializers.nsdm_subscription import NsdmSubscriptionIdSerializer
-from catalog.packages.serializers.nsdm_subscription import NsdmSubscriptionSerializer
 from catalog.packages.serializers.nsdm_subscription import NsdmSubscriptionRequestSerializer
+from catalog.packages.serializers.nsdm_subscription import NsdmSubscriptionSerializer
+from catalog.packages.serializers.nsdm_subscription import NsdmSubscriptionsSerializer
 from catalog.packages.serializers.response import ProblemDetailsSerializer
-
 from catalog.pub.exceptions import NsdmBadRequestException
-from catalog.packages.biz.nsdm_subscription import NsdmSubscription
 from .common import view_safe_call_with_log
 
 logger = logging.getLogger(__name__)
@@ -44,7 +44,7 @@ def validate_data(data, serializer):
 @swagger_auto_schema(
     method='POST',
     operation_description="Create Subscription for NSD Management",
-    tags=["NSD API"],
+    tags=[TAG_NSD_API],
     request_body=NsdmSubscriptionRequestSerializer(),
     responses={
         status.HTTP_201_CREATED: NsdmSubscriptionSerializer,
@@ -56,7 +56,7 @@ def validate_data(data, serializer):
 @swagger_auto_schema(
     method='GET',
     operation_description="Query subscriptions for Nsd Management",
-    tags=["NSD API"],
+    tags=[TAG_NSD_API],
     request_body=no_body,
     responses={
         status.HTTP_200_OK: NsdmSubscriptionsSerializer(),
@@ -69,6 +69,7 @@ def validate_data(data, serializer):
 @view_safe_call_with_log(logger=logger)
 def nsd_subscription_rc(request):
     if request.method == 'POST':
+        # Subscribe to NSD and PNFD change notifications.
         logger.debug("SubscribeNotification--post::> %s" % request.data)
         nsdm_subscription_request = \
             validate_data(request.data,
@@ -79,6 +80,7 @@ def nsd_subscription_rc(request):
         return Response(data=subscription, status=status.HTTP_201_CREATED)
 
     if request.method == 'GET':
+        # Query multiple subscriptions.
         logger.debug("Subscription Notification GET %s" % request.query_params)
         request_query_params = {}
         if request.query_params:
@@ -96,7 +98,7 @@ def nsd_subscription_rc(request):
 @swagger_auto_schema(
     method='GET',
     operation_description="Query subscriptions for Nsd Management",
-    tags=["NSD API"],
+    tags=[TAG_NSD_API],
     request_body=no_body,
     responses={
         status.HTTP_200_OK: NsdmSubscriptionSerializer(),
@@ -108,7 +110,7 @@ def nsd_subscription_rc(request):
 @swagger_auto_schema(
     method='DELETE',
     operation_description="Delete subscription for Nsd Management",
-    tags=["NSD API"],
+    tags=[TAG_NSD_API],
     request_body=no_body,
     responses={
         status.HTTP_204_NO_CONTENT: 'No_Content',
@@ -120,12 +122,20 @@ def nsd_subscription_rc(request):
 @api_view(http_method_names=['GET', 'DELETE'])
 @view_safe_call_with_log(logger=logger)
 def nsd_subscription_rd(request, **kwargs):
+    """
+    Individual subscription
+    :param request:
+    :param kwargs:
+    :return:
+    """
     subscription_id = kwargs.get("subscriptionId")
     validate_data({'subscription_id': subscription_id}, NsdmSubscriptionIdSerializer)
     if request.method == 'GET':
+        # Read an individual subscription resource
         subscription_data = NsdmSubscription().query_single_subscription(subscription_id)
         subscription = validate_data(subscription_data, NsdmSubscriptionSerializer)
         return Response(data=subscription.data, status=status.HTTP_200_OK)
     elif request.method == 'DELETE':
+        # Terminate a subscription
         subscription_data = NsdmSubscription().delete_single_subscription(subscription_id)
         return Response(status=status.HTTP_204_NO_CONTENT)