diff options
| author | Joffrey F <joffrey@docker.com> | 2017-01-18 15:38:53 -0800 |
|---|---|---|
| committer | Joffrey F <joffrey@docker.com> | 2017-01-18 15:38:53 -0800 |
| commit | 66d57333981f1f8a0f46c6c90a71c1ad020b0ac1 (patch) | |
| tree | ac7bb5b2731d40aaed71b4944014ab28e5ee7913 /docker/api/service.py | |
| parent | 91a185d7a57464d2b8826d48495bde02098a0079 (diff) | |
| download | docker-py-docs-fixes.tar.gz | |
Fix a number of docs formatting issuesdocs-fixes
Signed-off-by: Joffrey F <joffrey@docker.com>
Diffstat (limited to 'docker/api/service.py')
| -rw-r--r-- | docker/api/service.py | 32 |
1 files changed, 15 insertions, 17 deletions
diff --git a/docker/api/service.py b/docker/api/service.py index 7708b75..0d8421e 100644 --- a/docker/api/service.py +++ b/docker/api/service.py @@ -13,18 +13,18 @@ class ServiceApiMixin(object): Create a service. Args: - task_template (dict): Specification of the task to start as part - of the new service. + task_template (TaskTemplate): Specification of the task to start as + part of the new service. name (string): User-defined name for the service. Optional. labels (dict): A map of labels to associate with the service. Optional. mode (string): Scheduling mode for the service (``replicated`` or ``global``). Defaults to ``replicated``. - update_config (dict): Specification for the update strategy of the - service. Default: ``None`` - networks (list): List of network names or IDs to attach the - service to. Default: ``None``. - endpoint_config (dict): Properties that can be configured to + update_config (UpdateConfig): Specification for the update strategy + of the service. Default: ``None`` + networks (:py:class:`list`): List of network names or IDs to attach + the service to. Default: ``None``. + endpoint_spec (EndpointSpec): Properties that can be configured to access and load balance a service. Default: ``None``. Returns: @@ -159,7 +159,7 @@ class ServiceApiMixin(object): ``label`` and ``desired-state``. Returns: - (list): List of task dictionaries. + (:py:class:`list`): List of task dictionaries. Raises: :py:class:`docker.errors.APIError` @@ -186,20 +186,18 @@ class ServiceApiMixin(object): ID). version (int): The version number of the service object being updated. This is required to avoid conflicting writes. - task_template (dict): Specification of the updated task to start - as part of the service. See the [TaskTemplate - class](#TaskTemplate) for details. + task_template (TaskTemplate): Specification of the updated task to + start as part of the service. name (string): New name for the service. Optional. labels (dict): A map of labels to associate with the service. Optional. mode (string): Scheduling mode for the service (``replicated`` or ``global``). Defaults to ``replicated``. - update_config (dict): Specification for the update strategy of the - service. See the [UpdateConfig class](#UpdateConfig) for - details. Default: ``None``. - networks (list): List of network names or IDs to attach the - service to. Default: ``None``. - endpoint_config (dict): Properties that can be configured to + update_config (UpdateConfig): Specification for the update strategy + of the service. Default: ``None``. + networks (:py:class:`list`): List of network names or IDs to attach + the service to. Default: ``None``. + endpoint_spec (EndpointSpec): Properties that can be configured to access and load balance a service. Default: ``None``. Returns: |