Docstrings for get_vnf_record_ids

Change-Id: I4e71a5cef05bcd7f7e2657d180594f83bf09d7af
Signed-off-by: Daniel Arndt <daniel.arndt@canonical.com>

diff --git a/osm_lcm/temporal/ns_activities.py b/osm_lcm/temporal/ns_activities.py
index 12ffc76..b937717 100644 (file)
--- a/osm_lcm/temporal/ns_activities.py
+++ b/osm_lcm/temporal/ns_activities.py
@@ -40,6 +40,21 @@ class NsOperations:
     async def get_vnf_record_ids(
         self, get_vnf_record_ids_input: GetVnfRecordIdsInput
     ) -> GetVnfRecordIdsOutput:
+        """
+        Gets the list of VNF record IDs for a given NS record ID.
+
+        Collaborators:
+            DB Read:            vnfrs
+
+        Raises  (Retryable):
+            DbException         If the target DB record does not exist or DB is not reachable.
+
+        Activity Lifecycle:
+            This activity will not report a heartbeat due to its short-running nature.
+
+            Since this activity only reads from the DB, it is safe to retry, although
+            you may wish to have some back-off policy.
+        """
         vnfrs = self.db.get_list(
             "vnfrs", {"nsr-id-ref": get_vnf_record_ids_input.ns_uuid}
         )
@@ -51,7 +66,7 @@ class NsDbActivity:
     """Perform Database operations for NS accounts.
 
     Args:
-        db  (object):       Data Access Object
+        db  (database):       Data Access Object
     """
 
     def __init__(self, db: Database):