Add docstrings for database resources

Brian Curtin · Brian Curtin · commit 235474fe6501 · 2015-07-08T16:53:58.000-05:00
Closes-Bug: 1472781
Change-Id: I61f164c2d3c3765bafff67517709905050b6aa07
diff --git a/openstack/database/v1/database.py b/openstack/database/v1/database.py
@@ -27,7 +27,12 @@ class Database(resource.Resource):
     allow_list = True
 
     # Properties
+    #: Set of symbols and encodings. The default character set is ``utf8``.
     character_set = resource.prop('character_set')
+    #: Set of rules for comparing characters in a character set.
+    #: The default value for collate is ``utf8_general_ci``.
     collate = resource.prop('collate')
+    #: The ID of the instance
     instance_id = resource.prop('instance_id')
+    #: The name of the database
     name = resource.prop('name')
diff --git a/openstack/database/v1/flavor.py b/openstack/database/v1/flavor.py
@@ -25,6 +25,9 @@ class Flavor(resource.Resource):
     allow_retrieve = True
 
     # Properties
+    #: Links associated with the flavor
     links = resource.prop('links')
+    #: The name of the flavor
     name = resource.prop('name')
+    #: The size in MB of RAM the flavor has
     ram = resource.prop('ram')
diff --git a/openstack/database/v1/instance.py b/openstack/database/v1/instance.py
@@ -29,33 +29,63 @@ class Instance(resource.Resource):
     allow_list = True
 
     # Properties
+    #: The flavor of the instance
     flavor = resource.prop('flavor')
+    #: Links associated with the instance
     links = resource.prop('links')
+    #: The name of the instance
     name = resource.prop('name')
+    #: The status of the instance
     status = resource.prop('status')
+    #: The size of the volume
     volume = resource.prop('volume')
 
     def enable_root_user(self, session):
+        """Enable login for the root user
+
+        This operation enables login from any host for the root user
+        and provides the user with a generated root password.
+
+        :returns: A dictionary with keys ``name`` and ``password`` specifying
+        the login credentials.
+        """
         url = utils.urljoin(self.base_path, self.id, 'root')
         resp = session.post(url, service=self.service).body
         return resp['user']
 
     def is_root_enabled(self, session):
+        """Determine if root is enabled on an instance
+
+        :returns: ``True`` if root user is enabled for a specified database
+        instance or ``False`` otherwise.
+        """
         url = utils.urljoin(self.base_path, self.id, 'root')
         resp = session.get(url, service=self.service).body
         return resp['rootEnabled']
 
     def restart(self, session):
+        """Restart the database instance
+
+        :returns: ``None``
+        """
         body = {'restart': {}}
         url = utils.urljoin(self.base_path, self.id, 'action')
         session.post(url, service=self.service, json=body)
 
     def resize(self, session, flavor_reference):
+        """Resize the database instance
+
+        :returns: ``None``
+        """
         body = {'resize': {'flavorRef': flavor_reference}}
         url = utils.urljoin(self.base_path, self.id, 'action')
         session.post(url, service=self.service, json=body)
 
     def resize_volume(self, session, volume_size):
+        """Resize the volume attached to the instance
+
+        :returns: ``None``
+        """
         body = {'resize': {'volume': volume_size}}
         url = utils.urljoin(self.base_path, self.id, 'action')
         session.post(url, service=self.service, json=body)
diff --git a/openstack/database/v1/user.py b/openstack/database/v1/user.py
@@ -30,8 +30,11 @@ class User(resource.Resource):
     instance_id = resource.prop('instance_id')
 
     # Properties
+    #: Databases the user has access to
     databases = resource.prop('databases')
+    #: The name of the user
     name = resource.prop('name')
+    #: The password of the user
     password = resource.prop('password')
 
     @classmethod
