diff options
author | Jeremy Freudberg <jeremyfreudberg@gmail.com> | 2017-12-21 20:17:16 +0000 |
---|---|---|
committer | Jeremy Freudberg <jeremyfreudberg@gmail.com> | 2017-12-22 02:47:49 +0000 |
commit | b94d703a44887a0d820a8e9f23c5a60d17e2e333 (patch) | |
tree | 0ab0c391015a64f0009ac7a44f9cf909f2adab06 /saharaclient/api | |
parent | ce4eb355fde9b81e0c9b732d4d4346967a220c4a (diff) | |
download | python-saharaclient-b94d703a44887a0d820a8e9f23c5a60d17e2e333.tar.gz |
Properly document job binary "extra"
After bp sahara-support-s3 the use of the "extra" parameter is not only
for binaries stored in Swift.
So, modify some docstrings (which are in turn included in the actual
docs) to reflect this.
Change-Id: I3683fce981a7d1812d08f3545e9a8b1d8ebb6ec1
Diffstat (limited to 'saharaclient/api')
-rw-r--r-- | saharaclient/api/job_binaries.py | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/saharaclient/api/job_binaries.py b/saharaclient/api/job_binaries.py index 38637e3..2a49154 100644 --- a/saharaclient/api/job_binaries.py +++ b/saharaclient/api/job_binaries.py @@ -25,7 +25,14 @@ class JobBinariesManager(base.ResourceManager): def create(self, name, url, description=None, extra=None, is_public=None, is_protected=None): - """Create a Job Binary.""" + """Create a Job Binary. + + :param dict extra: authentication info needed for some job binaries, + containing the keys `username` and `password` for job binary in + Swift or the keys `accesskey`, `secretkey`, and `endpoint` for job + binary in S3 + + """ data = { "name": name, "url": url @@ -73,7 +80,9 @@ class JobBinariesManager(base.ResourceManager): * url * is_public * is_protected - * extra - dict with `user` and `password` keyword arguments + * extra - dict with the keys `username` and `password` for job binary + in Swift, or with the keys `accesskey`, `secretkey`, and `endpoint` + for job binary in S3 """ return self._update( '/job-binaries/%s' % job_binary_id, data, 'job_binary') |