From dd58008470b9a817c1ec8ed8efb9781a30c41995 Mon Sep 17 00:00:00 2001
From: Evan Cordell <cordell.evan@gmail.com>
Date: Tue, 18 Jul 2017 14:21:22 -0400
Subject: [PATCH] Add docs to data interface for repo notifications

---
 ...repositorynotification_models_interface.py | 69 ++++++++++++++++++-
 1 file changed, 67 insertions(+), 2 deletions(-)

diff --git a/endpoints/api/repositorynotification_models_interface.py b/endpoints/api/repositorynotification_models_interface.py
index f0f4a72af..4d8154735 100644
--- a/endpoints/api/repositorynotification_models_interface.py
+++ b/endpoints/api/repositorynotification_models_interface.py
@@ -29,12 +29,12 @@ class RepositoryNotification(
   def to_dict(self):
     try:
       config = json.loads(self.config_json)
-    except:
+    except ValueError:
       config = {}
 
     try:
       event_config = json.loads(self.event_config_json)
-    except:
+    except ValueError:
       event_config = {}
 
     return {
@@ -56,24 +56,89 @@ class RepoNotificationInterface(object):
   
   @abstractmethod
   def create_repo_notification(self, namespace_name, repository_name, event_name, method_name, method_config, event_config, title=None):
+    """
+    
+    Args:
+      namespace_name: namespace of repository
+      repository_name: name of repository
+      event_name: name of event
+      method_name: name of method
+      method_config: method config, json string
+      event_config: event config, json string
+      title: title of the notification
+
+    Returns:
+      RepositoryNotification object
+
+    """
     pass
   
   @abstractmethod
   def list_repo_notifications(self, namespace_name, repository_name, event_name=None):
+    """
+    
+    Args:
+      namespace_name: namespace of repository
+      repository_name: name of repository
+      event_name: name of event
+
+    Returns:
+      list(RepositoryNotification)
+    """
     pass
   
   @abstractmethod
   def get_repo_notification(self, uuid):
+    """
+    
+    Args:
+      uuid: uuid of notification
+
+    Returns:
+      RepositoryNotification or None
+
+    """
     pass  
   
   @abstractmethod
   def delete_repo_notification(self, namespace_name, repository_name, uuid):
+    """
+    
+    Args:
+      namespace_name: namespace of repository
+      repository_name: name of repository
+      uuid: uuid of notification
+    
+    Returns:
+      RepositoryNotification or None
+    
+    """
     pass
 
   @abstractmethod
   def reset_notification_number_of_failures(self, namespace_name, repository_name, uuid):
+    """
+    
+    Args:
+      namespace_name: namespace of repository
+      repository_name: name of repository
+      uuid: uuid of notification
+    
+    Returns:
+      RepositoryNotification
+    
+    """
     pass
 
   @abstractmethod
   def queue_test_notification(self, uuid):
+    """
+    
+    Args:
+      uuid: uuid of notification
+    
+    Returns:
+      RepositoryNotification or None
+    
+    """
     pass