openstack
/
sahara
Code Issues Proposed changes

Description of job config hints in new doc page is wrong 

The 'configs' field is not a dictionary, it is actually
a list of dictionaries.  Update the description.

Closes-Bug: #1357615
Change-Id: I540abe050f1d81e36f4b5dcca547a7e5c3514c84
(cherry picked from commit 61be4ece04)
This commit is contained in:
Trevor McKay 2014-10-01 12:34:14 -04:00 committed by Andrew Lazarev
parent 0d94b67fca
commit 4f23cfefa1
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/source/devref/edp.spi.rst
View File

@ -107,7 +107,12 @@ parameters, and arguments are used by different job types.
*Returns*: a dictionary of the following form, containing hints for configs,
parameters, and arguments for the job type:
{'job_config': {'configs': {}, 'params': {}, 'args': []}}
{'job_config': {'configs': [], 'params': {}, 'args': []}}
* *args* is a list of strings
* *params* contains simple key/value pairs
* each item in *configs* is a dictionary with entries
for 'name' (required), 'value', and 'description'
get_supported_job_types()