Merge pull request #33487 from jtand/glance_doc_fixes

Add docstring examples to glance.py and nova.py [2015.8]
This commit is contained in:
Mike Place 2016-05-25 09:47:25 -07:00
commit 70eb7b66f3
3 changed files with 26 additions and 0 deletions

View file

@ -448,6 +448,12 @@ def image_schema(profile=None):
'''
Returns names and descriptions of the schema "image"'s
properties for this profile's instance of glance
CLI Example:
.. code-block:: bash
salt '*' glance.image_schema
'''
return schema_get('image', profile)
@ -459,6 +465,13 @@ def image_update(id=None, name=None, profile=None, **kwargs): # pylint: disable
- min_ram (in MB)
- protected (bool)
- visibility ('public' or 'private')
CLI Example:
.. code-block:: bash
salt '*' glance.image_update id=c2eb2eb0-53e1-4a80-b990-8ec887eae7df
salt '*' glance.image_update name=f16-jeos
'''
if id:
image = image_show(id=id, profile=profile)
@ -512,6 +525,12 @@ def schema_get(name, profile=None):
- images
- member
- members
CLI Example:
.. code-block:: bash
salt '*' glance.schema_get name=f16-jeos
'''
g_client = _auth(profile)
pformat = pprint.PrettyPrinter(indent=4).pformat

View file

@ -559,6 +559,12 @@ def list_(profile=None):
'''
To maintain the feel of the nova command line, this function simply calls
the server_list function.
CLI Example:
.. code-block:: bash
salt '*' nova.list
'''
return server_list(profile=profile)

View file

@ -66,6 +66,7 @@ class SysModuleTest(integration.ModuleCase):
'runtests_decorators.depends_will_fallback',
'runtests_decorators.missing_depends',
'runtests_decorators.missing_depends_will_fallback',
'swift.head',
'yumpkg.expand_repo_def',
'yumpkg5.expand_repo_def',
'container_resource.run',