Merge "Generate API documentation"

This commit is contained in:
Jenkins
2015-03-25 05:17:08 +00:00
committed by Gerrit Code Review
5 changed files with 89 additions and 8 deletions
+9
View File
@@ -19,6 +19,15 @@ from glanceclient.common import utils
def Client(version=None, endpoint=None, *args, **kwargs):
"""Client for the OpenStack Images API.
Generic client for the OpenStack Images API. See version classes
for specific details.
:param string version: The version of API to use. Note this is
deprecated and should be passed as part of the URL
(http://$HOST:$PORT/v$VERSION_NUMBER).
"""
if version is not None:
warnings.warn(("`version` keyword is being deprecated. Please pass the"
" version as part of the URL. "
+5 -4
View File
@@ -71,10 +71,11 @@ class Controller(object):
return sort
def list(self, **kwargs):
"""Retrieve a listing of Image objects
"""Retrieve a listing of Image objects.
:param page_size: Number of images to request in each paginated request
:returns generator over list of Images
:param page_size: Number of images to request in each
paginated request.
:returns: generator over list of Images.
"""
ori_validate_fun = self.model.validate
@@ -238,7 +239,7 @@ class Controller(object):
:param image_id: ID of the image to modify.
:param remove_props: List of property names to remove
:param **kwargs: Image attribute names and their new values.
:param \*\*kwargs: Image attribute names and their new values.
"""
image = self.get(image_id)
for (key, value) in kwargs.items():