summaryrefslogtreecommitdiff
path: root/docker/api/service.py
diff options
context:
space:
mode:
authorJoffrey F <joffrey@docker.com>2017-11-06 16:04:00 -0800
committerJoffrey F <joffrey@docker.com>2017-11-06 16:07:11 -0800
commit80efa204570ce6de64142f1558e818f901e72f1d (patch)
tree0714158c5945537cc2e2d0d7a4e97437762cbc21 /docker/api/service.py
parent11a260225c5875584cc2c9af60e891dbed51bbba (diff)
downloaddocker-py-insert_defaults.tar.gz
Add support for insert_defaults in inspect_serviceinsert_defaults
Signed-off-by: Joffrey F <joffrey@docker.com>
Diffstat (limited to 'docker/api/service.py')
-rw-r--r--docker/api/service.py16
1 files changed, 13 insertions, 3 deletions
diff --git a/docker/api/service.py b/docker/api/service.py
index e6b4876..4c10ef8 100644
--- a/docker/api/service.py
+++ b/docker/api/service.py
@@ -136,12 +136,14 @@ class ServiceApiMixin(object):
@utils.minimum_version('1.24')
@utils.check_resource('service')
- def inspect_service(self, service):
+ def inspect_service(self, service, insert_defaults=None):
"""
Return information about a service.
Args:
- service (str): Service name or ID
+ service (str): Service name or ID.
+ insert_defaults (boolean): If true, default values will be merged
+ into the service inspect output.
Returns:
``True`` if successful.
@@ -151,7 +153,15 @@ class ServiceApiMixin(object):
If the server returns an error.
"""
url = self._url('/services/{0}', service)
- return self._result(self._get(url), True)
+ params = {}
+ if insert_defaults is not None:
+ if utils.version_lt(self._version, '1.29'):
+ raise errors.InvalidVersion(
+ 'insert_defaults is not supported in API version < 1.29'
+ )
+ params['insertDefaults'] = insert_defaults
+
+ return self._result(self._get(url, params=params), True)
@utils.minimum_version('1.24')
@utils.check_resource('task')