add comments

[vfc/nfvo/lcm.git] / lcm / ns / views / sol / heal_ns_view.py

diff --git a/lcm/ns/views/sol/heal_ns_view.py b/lcm/ns/views/sol/heal_ns_view.py
index 58418bd..e6e0ed5 100644 (file)
--- a/lcm/ns/views/sol/heal_ns_view.py
+++ b/lcm/ns/views/sol/heal_ns_view.py
@@ -17,7 +17,7 @@ from .common import view_safe_call_with_log
 from drf_yasg.utils import swagger_auto_schema
 from lcm.ns.biz.ns_heal import NSHealService
 from lcm.ns.const import NS_OCC_BASE_URI
-from lcm.pub.enum import JOB_TYPE
+from lcm.jobs.enum import JOB_TYPE, JOB_ACTION
 from lcm.pub.exceptions import BadRequestException
 from lcm.ns.serializers.sol.heal_serializers import HealNsReqSerializer
 from lcm.ns.serializers.sol.pub_serializers import ProblemDetailsSerializer
@@ -30,6 +30,11 @@ logger = logging.getLogger(__name__)
 
 
 class HealNSView(APIView):
+    """
+    This task resource represents the "Heal NS" operation.
+    The client can use this resource to request healing a NS instance.
+    """
+
     @swagger_auto_schema(
         request_body=HealNsReqSerializer(),
         responses={
@@ -39,13 +44,19 @@ class HealNSView(APIView):
     )
     @view_safe_call_with_log(logger=logger)
     def post(self, request, ns_instance_id):
+        """
+        The POST method requests to heal a NS instance resource.
+        :param request:
+        :param ns_instance_id:
+        :return:
+        """
         logger.debug("Enter HealNSView::post nsInstanceId:%s, request.data:%s" % (ns_instance_id, request.data))
         req_serializer = HealNsReqSerializer(data=request.data)
         if not req_serializer.is_valid():
             logger.error("request.data is not valid,error: %s" % req_serializer.errors)
             raise BadRequestException(req_serializer.errors)
 
-        job_id = JobUtil.create_job("NS", JOB_TYPE.HEAL_NS, ns_instance_id)
+        job_id = JobUtil.create_job(JOB_TYPE.NS, JOB_ACTION.HEAL, ns_instance_id)
         ns_heal_service = NSHealService(ns_instance_id, request.data, job_id)
         ns_heal_service.start()
         response = Response(data={}, status=status.HTTP_202_ACCEPTED)